alfresco-ng2-components/docs/core/services/search.service.md

Title, Added, Status, Last reviewed

Title	Added	Status	Last reviewed
Search service	v2.0.0	Active	2018-12-03

Search service

Accesses the Content Services Search API.

Class members

Methods

• getNodeQueryResults(term: string, options?: SearchOptions): Observable<NodePaging>
  Gets a list of nodes that match the given search criteria.
  • term: string - Term to search for
  • options: SearchOptions - (Optional) Options for delivery of the search results
  • Returns Observable<NodePaging> - List of nodes resulting from the search
• search(searchTerm: string, maxResults: number, skipCount: number): Observable<ResultSetPaging>
  Performs a search.
  • searchTerm: string - Term to search for
  • maxResults: number - Maximum number of items in the list of results
  • skipCount: number - Number of higher-ranked items to skip over in the list
  • Returns Observable<ResultSetPaging> - List of search results
• searchByQueryBody(queryBody: SearchRequest, shouldEmit: boolean = true): Observable<ResultSetPaging>
  Performs a search with its parameters supplied by a SearchRequest object.
  • queryBody: SearchRequest - Object containing the search parameters
  • shouldEmit: boolean - Whether the dataLoaded event should be emitted with the results. Set to false for auxiliary searches (for example populating autocomplete options) that should not notify the main results subscribers. Defaults to true
  • Returns Observable<ResultSetPaging> - List of search results

Details

See the search method in the Alfresco JS-API for the format of the query and returned data. The Search Configuration service has a method to generate the QueryBody object used by searchByQueryBody. The properties of the SearchOptions interface are documented in source file comments.

See also

• Search Configuration service