AboutSupportDeveloper GuideVersion 22.3.24

Interface CLISearchResultCustom<A>

A Search Result that renders custom templates.

interface CLISearchResultCustom<A> {
    actions: A[];
    data?: any;
    description?: string;
    icon?: string;
    key: string;
    label?: string;
    score?: number;
    shortDescription?: string;
    tags?: SearchTag[];
    template: Custom;
    templateContent: CustomTemplate;
    title: string;
}

Type Parameters

Hierarchy (view full)

Properties

actions data? description? icon? key label? score? shortDescription? tags? template templateContent title

Properties

actions

actions: A[]

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.

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.

template

template: Custom

templateContent

templateContent: CustomTemplate

title

title: string

UI friendly name for the search result.

Settings

On This Page

Properties