Share via

AdaptiveCardSearchResult interface

Package:
@microsoft/agents-hosting

Represents a single search result item returned from an Adaptive Card search operation.

Example

const searchResult: AdaptiveCardSearchResult = {
  title: "John Doe",
  value: "john.doe@company.com"
};

Remarks

This interface defines the structure for search results that are displayed to users when they perform searches within Adaptive Cards, such as typeahead or dropdown searches.

Properties

title

The display text shown to the user in the search results.

Example

"John Doe" or "Microsoft Teams - General Channel"
value

The underlying value associated with this search result.

Example

"john.doe@company.com" or "channel-id-12345"

Property Details

title

The display text shown to the user in the search results.

Example

"John Doe" or "Microsoft Teams - General Channel"

title: string

Property Value

string

Remarks

This is typically the human-readable label that appears in dropdowns, typeahead suggestions, or search result lists.

value

The underlying value associated with this search result.

Example

"john.doe@company.com" or "channel-id-12345"

value: string

Property Value

string

Remarks

This is usually the actual data value that gets selected when the user chooses this result, such as an ID, email address, or other identifier.