DispatchedSearchResult | @openfin/search-api

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",
   onSearch: myOnSearch,
   onResultDispatch: (dispatchedSearchResult) => {
      if (dispatchedSearchResult.action === "my-action") {
         doMyAction(dispatchedSearchResult);
      }
   }
};

Hierarchy

BaseSearchResult
- DispatchedSearchResult

Index

Properties

action

action: string

The selected action for the search provider to perform.

Optional actions

actions: Action[]

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

data

data: any

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

Optional description

description: string

Unused.

experimental

dispatcherIdentity

dispatcherIdentity: Identity

The OpenFin identity that dispatched this search result.

Optional icon

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.

Optional score

score: number

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

experimental

Optional shortDescription

shortDescription: string

Unused.

experimental

title

title: string

UI friendly name for the search result.

Generated using TypeDoc