inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
29132ec5c8e2802ee4242c5ac99a464132192fe7
alfresco-ng2-components/docs/core/services/search.service.md
AleksanderSklorz 02dcd4fb48 [ACS-4565] add search for categories tree in admin cc (#8279) 
* ACS-4565 Added possibility to search categories

* ACS-4565 Fixed unit test

* ACS-4565 Fixed lint issue

* ACS-4565 Removed extra empty line

* ACS-4565 Replaced tags label with categories label in unit tests

* ACS-4565 Replaced tags label with categories label in doc
2023-02-20 15:53:22 +00:00

3.0 KiB
Raw Blame History

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: QueryBody): Observable<ResultSetPaging>
    Performs a search with its parameters supplied by a QueryBody object.
    • queryBody: QueryBody - Object containing the search parameters
    • 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