mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2463] Moved doc files into subfolders (#3080)
This commit is contained in:
committed by
Eugenio Romano
parent
2889f6dcac
commit
86cc219bc4
30
docs/core/search-configuration.service.md
Normal file
30
docs/core/search-configuration.service.md
Normal file
@@ -0,0 +1,30 @@
|
||||
---
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
---
|
||||
# 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](../content-services/search.component.md)
|
||||
- [Search configuration interface](search-configuration.interface.md)
|
Reference in New Issue
Block a user