Schema Explorer

Choose element:

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 targetting 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.

Refresh

Defines how a card can be refreshed by making a request to the target Bot.

Introduced in version 1.4

Property Type Required Description Version
action Action.Execute No The action to be executed to refresh the card. Clients can run this refresh action automatically or can provide an affordance for users to trigger it manually. 1.4
userIds string[] No A list of user Ids informing the client for which users should the refresh action should be run automatically. Some clients will not run the refresh action automatically unless this property is specified. Some clients may ignore this property and always run the refresh action automatically. 1.4

Properties

action

The action to be executed to refresh the card. Clients can run this refresh action automatically or can provide an affordance for users to trigger it manually.

  • Type: Action.Execute
  • Required: No
  • Allowed values:
    • Action.Execute

userIds

A list of user Ids informing the client for which users should the refresh action should be run automatically. Some clients will not run the refresh action automatically unless this property is specified. Some clients may ignore this property and always run the refresh action automatically.

  • Type: string[]
  • Required: No