AboutSupportDeveloper GuideVersion 18.0.10

Interface SearchProviderInfo

Information about a search provider.

Hierarchy

Properties

clientAPIVersion? commandCode? description? dispatchFocusEvents? hidden? icon id identity? inputPlaceholder? listTitle? logoUrl? scoreOrder? title

Properties

Optional clientAPIVersion

clientAPIVersion?: string

version of client SDK, set by the API

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 dispatchFocusEvents

dispatchFocusEvents?: boolean

If set, focusing on a search result will trigger onResultDispatch callback.

Optional hidden

hidden?: boolean

A flag to indicate this provider will not be displayed as a command.

icon

icon: string

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

id

id: string

A unique ID used to identify the search provider.

Optional identity

identity?: Identity_5

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.

Optional listTitle

listTitle?: string

A title to display above the result list in a UI when targeting this specific Search Provider.

Optional logoUrl

logoUrl?: string

Logo to show render when targeting this specific Search Provider.

Optional Experimental scoreOrder

scoreOrder?: ScoreOrder

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

title

title: string

A UI friendly title for the search provider.

Settings

Theme

On This Page