OpenFin Workspace API
    Preparing search index...

    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 Summary)

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

    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

    Unused.

    dispatcherIdentity: Identity_4

    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

    Unused.

    tags?: SearchTag[]

    Tags associated with the search result.

    title: string

    UI friendly name for the search result.

    Settings

    On This Page
    Properties