alfresco-ng2-components/docs/search-configuration.service.md
Andy Stark 87101d4e85 [ADF-2201] Search Configuration doc (#2876)
* [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
2018-01-24 19:23:50 +01:00

1.0 KiB

Search Configuration service

Provides fine control of parameters to a search.

Methods

generateQueryBody(searchTerm: string, maxResults: string, skipCount: string): QueryBody
Generates a QueryBody object with custom search parameters.

Details

The generateQueryBody method returns a QueryBody 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.

See also