mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
c83d92c539
* [ci:force] migrate from QueryBody to SearchQuery * [ci:force] migrate from QueryBody to SearchQuery * [ci:force] migrate from QueryBody to SearchQuery * [ci:force] update docs and variables as per code review
1.6 KiB
1.6 KiB
Title, Added, Status, Last reviewed
| Title | Added | Status | Last reviewed |
|---|---|---|---|
| Search Configuration service | v2.1.0 | Active | 2018-09-13 |
Search Configuration service
Provides fine control of parameters to a search.
Class members
Methods
- generateQueryBody(searchTerm:
string, maxResults:number, skipCount:number):SearchRequest
Generates a request object with custom search parameters.- searchTerm:
string- Term text to search for - maxResults:
number- Maximum number of search results to show in a page - skipCount:
number- The offset of the start of the page within the results list - Returns
SearchRequest- Query body defined by the parameters
- searchTerm:
Details
The generateQueryBody method returns a SearchRequest object.
This configures the search to use searchTerm along with maxResults and skipCount
specified for the paging of the search results.
This service is a standard implementation of the Search configuration interface that works well for many common cases. However, you can also supply your own implementation if you need to. See the Search configuration interface page for full details and example code.