• Public
  • Public/Protected
  • All

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.




Optional commandCode

commandCode: string

A keycode that can be used to interact with this Search Provider.

Optional description

description: string

A short description of the Search Provider.

Optional hint

hint: string

A breadcrumb that a UI could display.

Optional icon

icon: string

An icon that a UI can display for the Search Provider.

Optional identity

identity: Identity

The OpenFin identity that registered this search provider.

Optional inputPlaceholder

inputPlaceholder: string

The placeholder string to be displayed in a UI when targeting this specific Search Provider.


name: string

A unique ID used to identify the search provider.

Optional onResultDispatch

onResultDispatch: ResultDispatchListener

An optional listener for actioning search results.

When this search provider returns search results via its onSearch 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.


onSearch: SearchListener

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 scoreOrder

scoreOrder: ScoreOrder

The order to sort the score in. The default is ascending.



title: string

A UI friendly title for the search provider.


  • Property
  • Method

Generated using TypeDoc