Schema Explorer
Action.Submit
Gathers input fields, merges with optional data field, and sends an event to the client. It is up to the client to determine how this data is processed. For example: With BotFramework bots, the client would send an activity through the messaging medium to the bot.
Property | Type | Required | Description | Version |
---|---|---|---|---|
type | "Action.Submit" |
Yes | Must be "Action.Submit" . |
1.0 |
data | string , object |
No | Initial data that input fields will be combined with. These are essentially ‘hidden’ properties. | 1.0 |
Inherited properties
Property | Type | Required | Description | Version |
---|---|---|---|---|
title | string |
No | Label for button or link that represents this action. | 1.0 |
iconUrl | uri |
No | Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+ | 1.1 |
style | ActionStyle |
No | Controls the style of an Action, which influences how the action is displayed, spoken, etc. | 1.2 |
fallback | Action , FallbackOption |
No | Describes what to do when an unknown element is encountered or the requires of this or any children can’t be met. | 1.2 |
requires | Dictionary<string> |
No | A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered. | 1.2 |
Example
Properties
data
Initial data that input fields will be combined with. These are essentially ‘hidden’ properties.
- Type:
string
,object
- Required: No
title
Label for button or link that represents this action.
- Type:
string
- Required: No
iconUrl
Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
- Type:
uri
- Version : 1.1
- Required: No
style
Controls the style of an Action, which influences how the action is displayed, spoken, etc.
- Type:
ActionStyle
- Version : 1.2
- Required: No
- Allowed values:
"default"
: Action is displayed as normal"positive"
: Action is displayed with a positive style (typically the button becomes accent color)"destructive"
: Action is displayed with a destructive style (typically the button becomes red)
fallback
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
- Type:
Action
,FallbackOption
- Version : 1.2
- Required: No
- Allowed values:
Action.OpenUrl
Action.ShowCard
Action.Submit
Action.ToggleVisibility
"drop"
: Causes this element to be dropped immediately when unknown elements are encountered. The unknown element doesn't bubble up any higher.
requires
A series of key/value pairs indicating features that the item requires with corresponding minimum version. When a feature is missing or of insufficient version, fallback is triggered.
- Type:
Dictionary<string>
- Version : 1.2
- Required: No