OptionalclientAPIVersionversion of client SDK, set by the API
OptionalcommandA keycode that can be used to interact with this Search Provider.
OptionaldescriptionA short description of the Search Provider.
OptionaldispatchIf set, focusing on a search result will trigger onResultDispatch callback.
OptionalhiddenA 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.
OptionalidentityThe OpenFin identity that registered this search provider.
OptionalinputA placeholder text that would be put into the empty search field for the selected provider for home in landing mode.
OptionalinputThe placeholder string to be displayed in a UI when targeting this specific Search Provider.
OptionallistA title to display above the result list in a UI when targeting this specific Search Provider.
OptionallogoLogo to show render when targeting this specific Search Provider.
OptionalonAn 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.
Optional ExperimentalscoreThe order to sort the score in. The default is ascending.
A UI friendly title for the search provider.
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.