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
39 lines
1.6 KiB
Markdown
39 lines
1.6 KiB
Markdown
---
|
|
Title: Search Configuration service
|
|
Added: v2.1.0
|
|
Status: Active
|
|
Last reviewed: 2018-09-13
|
|
---
|
|
|
|
# [Search Configuration service](../../../lib/content-services/src/lib/search/services/search-configuration.service.ts "Defined in search-configuration.service.ts")
|
|
|
|
Provides fine control of parameters to a search.
|
|
|
|
## Class members
|
|
|
|
### Methods
|
|
|
|
- **generateQueryBody**(searchTerm: `string`, maxResults: `number`, skipCount: `number`): `SearchRequest`<br/>
|
|
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
|
|
|
|
## 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](../interfaces/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](../interfaces/search-configuration.interface.md) page for full details and
|
|
example code.
|
|
|
|
## See also
|
|
|
|
- [Search component](../../content-services/components/search.component.md)
|
|
- [Search configuration interface](../interfaces/search-configuration.interface.md)
|