Show TOC

SearchProvider MethodsLocate this document in the navigation structure

Use

getProviders(callback)

Returns an array of search providers available for the current user, and passes this array to the specified callback function

Parameters

Parameter

Description

callback

The callback function to which the array is passed

setDefaultProvider(key)

Sets the specified search provider as default

Parameters

Parameter

Description

key

The key of the search provider

getDefaultProvider()

Returns the default search provider

registerOnDefaultProviderChange(callback)

Registers a notification function to call when the search provider is set as default

Parameters

Parameter

Description

callback

The notification function to call when the search provider is set as default

search( term, searchProvider, searchType, searchCategory )

Performs search according to the specified term, search provider, search type and category

Parameters

Parameter

Description

term

The term to search for

searchProvider

The SearchProvider object that should perform the search

searchType

The SearchType object of the search provider, such as basic or advanced, defined by custom implementation

searchCategory

The category in which to search for the specified term