mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-26 17:24:56 +00:00
87101d4e85
* [ADF-2201] Updated search component docs and tidied index page * [ADF-2201] Fixed incorrect link * [ADF-2201] Updated docs based on feedback * [ADF-2201] Fixed broken relative link
27 lines
1.0 KiB
Markdown
27 lines
1.0 KiB
Markdown
# Search Configuration service
|
|
|
|
Provides fine control of parameters to a search.
|
|
|
|
## Methods
|
|
|
|
`generateQueryBody(searchTerm: string, maxResults: string, skipCount: string): QueryBody`<br/>
|
|
Generates a QueryBody object with custom search parameters.
|
|
|
|
## Details
|
|
|
|
The `generateQueryBody` method returns a
|
|
[QueryBody](https://github.com/Alfresco/alfresco-js-api/blob/1.6.0/src/alfresco-search-rest-api/docs/QueryBody.md)
|
|
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](search-configuration.interface.md) that works well for many
|
|
common cases. However, you can also supply your own implementation if you need to. See the
|
|
[Search configuration interface](search-configuration.interface.md) page for full details and
|
|
example code.
|
|
|
|
## See also
|
|
|
|
- [Search component](search.component.md)
|
|
- [Search configuration interface](search-configuration.interface.md)
|