A keycode that can be used to interact with this Search Provider.
A short description of the Search Provider.
A flag to indicate this provider will not be displayed as a command.
An icon that a UI can display for the Search Provider.
A unique ID used to identify the search provider.
The OpenFin identity that registered this search provider.
The placeholder string to be displayed in a UI when targeting this specific Search Provider.
A title to display above the result list in a UI when targeting this specific Search Provider.
Logo to show render when targeting this specific Search Provider.
An optional listener for actioning search results.
When this search provider returns search results via its onUserInput
listener,
the receiver of the results can select and dispatch a single result back to the provider.
It is then up to the search provider to perform the custom requested action.
The search listener for the search provider.
When a search is requested on the subscribed search topic, this listener will be called and have the opportunity to return search results.
The order to sort the score in. The default is ascending
.
A UI friendly title for the search provider.
Generated using TypeDoc
A search provider listens for search requests on a search topic and returns search results. It optionally can also perform custom actions when a search result is dispatched back to the provider.