Schema Explorer
Important note about accessibility: In version 1.3 of the schema we introduced a label property on Inputs to improve accessibility. If the Host app you are targeting supports v1.3 you should use label instead of a TextBlock as seen in some samples below. Once most Host apps have updated to the latest version we will update the samples accordingly.
Data.Query
The data populated in the event payload for fetching dynamic choices, sent to the card-author to help identify the dataset from which choices might be fetched to be displayed in the dropdown. It might contain auxillary data to limit the maximum number of choices that can be sent and to support pagination.
| Property | Type | Required | Description | Version |
|---|---|---|---|---|
| dataset | string |
Yes | The dataset to be queried to get the choices. | 1.6 |
| count | number |
No | The maximum number of choices that should be returned by the query. It can be ignored if the card-author wants to send a different number. | 1.6 |
| skip | number |
No | The number of choices to be skipped in the list of choices returned by the query. It can be ignored if the card-author does not want pagination. | 1.6 |
Properties
dataset
The dataset to be queried to get the choices.
- Type:
string - Version : 1.6
- Required: Yes
count
The maximum number of choices that should be returned by the query. It can be ignored if the card-author wants to send a different number.
- Type:
number - Version : 1.6
- Required: No
skip
The number of choices to be skipped in the list of choices returned by the query. It can be ignored if the card-author does not want pagination.
- Type:
number - Version : 1.6
- Required: No
