Options
All
  • Public
  • Public/Protected
  • All
Menu

Non-Template Search Result

Hierarchy

Index

Properties

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

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

template

template: Plain

title

title: string

UI friendly name for the search result.

Legend

  • Property
  • Method

Generated using TypeDoc