inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-12 17:04:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
alfresco-ng2-components/docs/core/services/search-configuration.service.md
Andy Stark 31479cfaa4 [ADF-4152] Restructured remaining doc folders and fixed links (#4441) 
* [ADF-4152] Moved proc services cloud docs to subfolders

* [ADF-4152] Fixed links in PS cloud docs

* [ADF-4152] Added subfolders and checked links for extensions and insights docs

* [ADF-4152] Moved proc services cloud docs to subfolders

* [ADF-4152] Fixed links in PS cloud docs

* [ADF-4152] Added subfolders and checked links for extensions and insights docs

* [ADF-4152] Fixed links in Proc cloud, Insights and Extensions docs

* [ADF-4152] Updated links in user guide

* [ADF-4152] Fixed broken links in tutorials

* [ADF-4152] Fixed remaining links in core docs

* [ADF-4152] Fixed remaining links in proc services docs

* [ADF-4152] Fixed remaining links in content services docs

* [ADF-4152] Fixed links in breaking changes docs

* [ADF-4152] Updated main README index page

* [ADF-4152] Fixed glitches with preview ext component docs
2019-03-14 22:01:55 +00:00

1.6 KiB
Raw Blame History

Title, Added, Status, Last reviewed
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