Skip to main content

Describes an individual search result received by search clients.

Properties (8)

Property Type Default Required Description
action⚓︎ MainAction x x

A main action that can be used to invoke an already registered Interop method when the user clicks on the search result displayed in a UI. If you need to define multiple actions when handling search results, you can use the secondaryActions property instead.

description⚓︎ string x x

Description for the search result that can be used in a UI.

displayName⚓︎ string x x

Display name for the search result that can be used in a UI.

iconURL⚓︎ string x x

URL pointing to an icon for the search result that can be used in a UI.

id⚓︎ string x x

ID for the search result that can be used by the search client when handling the result.

metadata⚓︎ any x x

Metadata for the search result that can be used by the search client when handling the result.

secondaryActions⚓︎ SecondaryAction[] x x

Secondary actions can be used to invoke different already registered Interop methods if, for example, you want to present the user with a choice of options related to the search result. The secondaryActions property can be used independently, without defining a MainAction in the action property.

type⚓︎ SearchType x

The predefined search type of the result.