OpenFin Workspace API
    Preparing search index...

    Interface CLISearchResultLoading<A>

    Loading Search Result

    interface CLISearchResultLoading<A extends Action = Action> {
        actions: A[];
        data?: any;
        description?: string;
        icon?: string;
        key: string;
        label?: string;
        score?: number;
        shortDescription?: string;
        tags?: SearchTag[];
        template: Loading;
        templateContent: string;
        title: string;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    actions data? description? icon? key label? score? shortDescription? tags? template templateContent title
    actions: A[]

    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.

    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.

    template: Loading
    templateContent: string
    title: string

    UI friendly name for the search result.

    Settings

    On This Page
    Properties