AboutSupportDeveloper GuideVersion 22.3.18

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") {
         doMyAction(dispatchedSearchResult);
      }
   }
};
interface DispatchedSearchResult {
    action: DispatchedAction;
    actions: Action[];
    data?: any;
    description?: string;
    dispatcherIdentity: Identity_4;
    icon?: string;
    key: string;
    label?: string;
    score?: number;
    shortDescription?: string;
    tags?: SearchTag[];
    title: string;
}

Hierarchy (view full)

Properties

action actions data? description? dispatcherIdentity icon? key label? score? shortDescription? tags? title

Properties

action

action: DispatchedAction

The selected action for the search provider to perform.

actions

actions: Action[]

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

Optionaldata

data?: any

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

Optional Experimentaldescription

description?: string

Unused.

dispatcherIdentity

dispatcherIdentity: Identity_4

The OpenFin identity that dispatched this search result.

Optionalicon

icon?: string

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

key

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.

Optionallabel

label?: string

A label to render with the search result.

Optional Experimentalscore

score?: number

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

Optional ExperimentalshortDescription

shortDescription?: string

Unused.

Optionaltags

tags?: SearchTag[]

Tags associated with the search result.

title

title: string

UI friendly name for the search result.

Settings

On This Page

Properties