Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.62 KB

search-configuration.service.md

File metadata and controls

39 lines (29 loc) · 1.62 KB
Title Added Status Last reviewed
Search Configuration service
v2.1.0
Active
2018-09-13

Search Configuration service

Provides fine control of parameters to a search.

Class members

Methods

  • generateQueryBody(searchTerm: string, maxResults: number, skipCount: number): QueryBody
    Generates a QueryBody 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 QueryBody - Query body defined by the 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