inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2026-09-09 18:03:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-2201] Search Configuration doc (#2876)

Browse Source 
* [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
This commit is contained in:
Andy Stark
2018-01-24 19:23:50 +01:00
committed by Vito
parent 8e4017ed19
commit 87101d4e85
7 changed files with 139 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/search-configuration.service.md
+26
View File
@@ -0,0 +1,26 @@
# 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)