AboutSupportDeveloper GuideVersion 22.3.18

Interface SearchProviderInfo

Information about a search provider.

interface SearchProviderInfo {
    clientAPIVersion?: string;
    commandCode?: string;
    description?: string;
    dispatchFocusEvents?: boolean;
    hidden?: boolean;
    icon: string;
    id: string;
    identity?: Identity_4;
    inputLandingPlaceholder?: string;
    inputPlaceholder?: string;
    listTitle?: string;
    logoUrl?: string;
    scoreOrder?: ScoreOrder;
    title: string;
}

Hierarchy (view full)

Properties

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

Properties

OptionalclientAPIVersion

clientAPIVersion?: string

version of client SDK, set by the API

OptionalcommandCode

commandCode?: string

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

Optionaldescription

description?: string

A short description of the Search Provider.

OptionaldispatchFocusEvents

dispatchFocusEvents?: boolean

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

Optionalhidden

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.

Optionalidentity

identity?: Identity_4

The OpenFin identity that registered this search provider.

OptionalinputLandingPlaceholder

inputLandingPlaceholder?: string

A placeholder text that would be put into the empty search field for the selected provider for home in landing mode.

OptionalinputPlaceholder

inputPlaceholder?: string

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

OptionallistTitle

listTitle?: string

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

OptionallogoUrl

logoUrl?: string

Logo to show render when targeting this specific Search Provider.

Optional ExperimentalscoreOrder

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

On This Page

Properties