AboutSupportDeveloper GuideVersion 18.0.10

Interface DispatchedSearchResult

A search result that has been dispatched back to the SearchProvider's onResultDispatch listener function. Contains the action that should be performed by the search provider.

const provider = {
name: "my-provider",
title: "My Provider",
onUserInput: myOnUserInput,
onResultDispatch: (dispatchedSearchResult) => {
if (dispatchedSearchResult.action.name === "my-action") {



The selected action for the search provider to perform.

actions: Action[]

Actions that can be performed with this search result. Used when dispatching search results back to the respective provider.

data?: any

Additional custom metadata about the search result. Can be used when actioning the search result.

description?: string


dispatcherIdentity: Identity_5

The OpenFin identity that dispatched this search result.

icon?: string

An optional icon that can be used when displaying the search result in a UI.

key: string

A unique ID for the search result. Can be used to update a previously returned search result by calling searchRequestContext.respond(result) with the same search result key.

label?: string

A label to render with the search result.

score?: number

Used when sorting a list of search results for a single provider.

shortDescription?: string


tags?: SearchTag[]

Tags associated with the search result.

title: string

UI friendly name for the search result.