tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > SearchService

SearchService class

Signature:

export declare class SearchService

Methods

Method	Modifiers	Description
advancedSearch({ searchQueries, resultLimit, details, })	static	Performs advanced search either on system-level or within a given search scope. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Batch</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalContainer</li><li>ExternalKeyword</li><li>Folder</li><li>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>
searchInContainer({ escapedItemId, fullTextQuery, itemTypes, resultLimit, })	static	Searches within an individual item for a specified text string. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Batch</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalContainer</li><li>ExternalKeyword</li><li>Folder</li><li>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>
systemSearch({ fullTextQuery, resultLimit, usedKeywordsIds, })	static	Searches the system for a specified text string. This operation returns an instance of ‘IdentifiableObject’ type, as implemented by one of the following:<ul class="model-list"><li>ActivityHistory</li><li>ActivityInstance</li><li>ApprovalStatus</li><li>Batch</li><li>Bundle</li><li>BusinessProcessType</li><li>Category</li><li>Component</li><li>ComponentTemplate</li><li>ExternalCategory</li><li>ExternalComponent</li><li>ExternalContainer</li><li>ExternalKeyword</li><li>Folder</li><li>Group</li><li>Keyword</li><li>MultimediaType</li><li>Page</li><li>PageTemplate</li><li>ProcessHistory</li><li>ProcessInstance</li><li>Publication</li><li>PublishTransaction</li><li>Schema</li><li>SearchFolder</li><li>StructureGroup</li><li>TargetGroup</li><li>TargetType</li><li>TemplateBuildingBlock</li><li>TridionActivityDefinition</li><li>TridionProcessDefinition</li><li>User</li><li>WorkItem</li></ul>