latest--adaptive-card
shared| Schema URL | https://catalog.lintel.tools/schemas/schemastore/ui5-manifest/_shared/latest--adaptive-card.json |
|---|---|
| Parent schema | ui5-manifest |
Any of
Definitions
Gathers input fields, merges with optional data field, and sends an event to the client. Clients process the event by sending an Invoke activity of type adaptiveCard/action to the target Bot. The inputs that are gathered are those on the current card, and in the case of a show card those on any parent cards. See Universal Action Model documentation for more details.
Must be Action.Execute
The card author-defined verb associated with this action.
Initial data that input fields will be combined with. These are essentially ‘hidden’ properties.
When invoked, show the given url either by launching it in an external web browser or showing within an embedded web browser.
The URL to open.
Must be Action.OpenUrl
Defines an AdaptiveCard which is shown to the user when the button or link is clicked.
Must be Action.ShowCard
An Adaptive Card, containing a free-form body of card elements, and an optional set of actions.
15 nested properties
Must be AdaptiveCard
Schema version that this card requires. If a client is lower than this version, the fallbackText will be rendered. NOTE: Version is not required for cards within an Action.ShowCard. However, it is required for the top-level card.
Defines how a card can be refreshed by making a request to the target Bot.
3 nested properties
Must be Refresh
Gathers input fields, merges with optional data field, and sends an event to the client. Clients process the event by sending an Invoke activity of type adaptiveCard/action to the target Bot. The inputs that are gathered are those on the current card, and in the case of a show card those on any parent cards. See Universal Action Model documentation for more details.
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.
Defines authentication information associated with a card. This maps to the OAuthCard type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.oauthcard)
5 nested properties
Must be Authentication
Text that can be displayed to the end user when prompting them to authenticate.
The identifier for registered OAuth connection setting information.
Defines information required to enable on-behalf-of single sign-on user authentication. Maps to the TokenExchangeResource type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.tokenexchangeresource)
Buttons that should be displayed to the user when prompting for authentication. The array MUST contain one button of type "signin". Other button types are not currently supported.
The card elements to show in the primary card region.
The Actions to show in the card's action bar.
Text shown when the client doesn't support the version specified (may contain markdown).
Specifies the background image of the card.
Specifies the minimum height of the card.
When true content in this Adaptive Card should be presented right to left. When 'false' content in this Adaptive Card should be presented left to right. If unset, the default platform behavior will apply.
Specifies what should be spoken for this entire card. This is simple text or SSML fragment.
The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions.
The Adaptive Card schema.
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. The inputs that are gathered are those on the current card, and in the case of a show card those on any parent cards. See https://docs.microsoft.com/en-us/adaptive-cards/authoring-cards/input-validation for more details.
Must be Action.Submit
Initial data that input fields will be combined with. These are essentially ‘hidden’ properties.
An action that toggles the visibility of associated card elements.
The array of TargetElements. It is not recommended to include Input elements with validation under Action.Toggle due to confusion that can arise from invalid inputs that are not currently visible. See https://docs.microsoft.com/en-us/adaptive-cards/authoring-cards/input-validation for more information.
Must be Action.ToggleVisibility
Represents an entry for Action.ToggleVisibility's targetElements property
An Adaptive Card, containing a free-form body of card elements, and an optional set of actions.
Must be AdaptiveCard
Schema version that this card requires. If a client is lower than this version, the fallbackText will be rendered. NOTE: Version is not required for cards within an Action.ShowCard. However, it is required for the top-level card.
Defines how a card can be refreshed by making a request to the target Bot.
3 nested properties
Must be Refresh
Gathers input fields, merges with optional data field, and sends an event to the client. Clients process the event by sending an Invoke activity of type adaptiveCard/action to the target Bot. The inputs that are gathered are those on the current card, and in the case of a show card those on any parent cards. See Universal Action Model documentation for more details.
13 nested properties
Must be Action.Execute
The card author-defined verb associated with this action.
Initial data that input fields will be combined with. These are essentially ‘hidden’ properties.
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.
Defines authentication information associated with a card. This maps to the OAuthCard type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.oauthcard)
5 nested properties
Must be Authentication
Text that can be displayed to the end user when prompting them to authenticate.
The identifier for registered OAuth connection setting information.
Defines information required to enable on-behalf-of single sign-on user authentication. Maps to the TokenExchangeResource type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.tokenexchangeresource)
4 nested properties
The unique identified of this token exchange instance.
An application ID or resource identifier with which to exchange a token on behalf of. This property is identity provider- and application-specific.
An identifier for the identity provider with which to attempt a token exchange.
Must be TokenExchangeResource
Buttons that should be displayed to the user when prompting for authentication. The array MUST contain one button of type "signin". Other button types are not currently supported.
The card elements to show in the primary card region.
The Actions to show in the card's action bar.
Text shown when the client doesn't support the version specified (may contain markdown).
Specifies the background image of the card.
Specifies the minimum height of the card.
When true content in this Adaptive Card should be presented right to left. When 'false' content in this Adaptive Card should be presented left to right. If unset, the default platform behavior will apply.
Specifies what should be spoken for this entire card. This is simple text or SSML fragment.
The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions.
The Adaptive Card schema.
Displays a set of actions.
The array of Action elements to show.
Must be ActionSet
Defines a container that is part of a ColumnSet.
Must be Column
The card elements to render inside the Column.
Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
Determines whether the column should bleed through its parent's padding.
Describes what to do when an unknown item is encountered or the requires of this or any children can't be met.
Specifies the minimum height of the column in pixels, like "80px".
When true content in this column should be presented right to left. When 'false' content in this column should be presented left to right. When unset layout direction will inherit from parent container or column. If unset in all ancestors, the default platform behavior will apply.
When true, draw a separating line between this column and the previous column.
Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.
Style hint for Column.
Defines how the content should be aligned vertically within the column. When not specified, the value of verticalContentAlignment is inherited from the parent container. If no parent container has verticalContentAlignment set, it defaults to Top.
"auto", "stretch", a number representing relative width of the column in the column group, or in version 1.1 and higher, a specific pixel width, like "50px".
ColumnSet divides a region into Columns, allowing elements to sit side-by-side.
Must be ColumnSet
The array of Columns to divide the region into.
Style hint for ColumnSet.
Determines whether the element should bleed through its parent's padding.
Specifies the minimum height of the column set in pixels, like "80px".
Controls the horizontal alignment of the ColumnSet. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.
Containers group items together.
The card elements to render inside the Container.
Must be Container
Style hint for Container.
Defines how the content should be aligned vertically within the container. When not specified, the value of verticalContentAlignment is inherited from the parent container. If no parent container has verticalContentAlignment set, it defaults to Top.
Determines whether the element should bleed through its parent's padding.
Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
Specifies the minimum height of the container in pixels, like "80px".
When true content in this container should be presented right to left. When 'false' content in this container should be presented left to right. When unset layout direction will inherit from parent container or column. If unset in all ancestors, the default platform behavior will apply.
Describes a Fact in a FactSet as a key/value pair.
The title of the fact.
The value of the fact.
Must be Fact
The FactSet element displays a series of facts (i.e. name/value pairs) in a tabular form.
The array of Fact's.
Must be FactSet
Displays an image. Acceptable formats are PNG, JPEG, and GIF
The URL to the image. Supports data URI in version 1.2+
Must be Image
Alternate text describing the image.
Applies a background to a transparent image. This property will respect the image style.
The desired height of the image. If specified as a pixel value, ending in 'px', E.g., 50px, the image will distort to fit that exact height. This overrides the size property.
Controls how this element is horizontally positioned within its parent. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.
Controls the approximate size of the image. The physical dimensions will vary per host. Every option preserves aspect ratio.
Controls how this Image is displayed.
The desired on-screen width of the image, ending in 'px'. E.g., 50px. This overrides the size property.
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
When true, draw a separating line at the top of the element.
Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.
A unique identifier associated with the item.
If false, this item will be removed from the visual tree.
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.
The ImageSet displays a collection of Images similar to a gallery. Acceptable formats are PNG, JPEG, and GIF
The array of Image elements to show.
Must be ImageSet
Controls the approximate size of the image. The physical dimensions will vary per host. Every option preserves aspect ratio.
Defines a single run of formatted text. A TextRun with no properties set can be represented in the json as string containing the text as a shorthand for the json object. These two representations are equivalent.
Describes a choice for use in a ChoiceSet.
Text to display.
The raw value for the choice. NOTE: do not use a , in the value, since a ChoiceSet with isMultiSelect set to true returns a comma-delimited string of choice values.
Must be Input.Choice
Allows a user to input a Choice.
Must be Input.ChoiceSet
Choice options.
Allow multiple choices to be selected.
Style hint for Input.ChoiceSet.
The initial choice (or set of choices) that should be selected. For multi-select, specify a comma-separated string of values.
Description of the input desired. Only visible when no selection has been made, the style is compact and isMultiSelect is false
If true, allow text to wrap. Otherwise, text is clipped.
Lets a user choose a date.
Must be Input.Date
Hint of maximum value expressed in YYYY-MM-DD(may be ignored by some clients).
Hint of minimum value expressed in YYYY-MM-DD(may be ignored by some clients).
Description of the input desired. Displayed when no selection has been made.
The initial value for this field expressed in YYYY-MM-DD.
Allows a user to enter a number.
Must be Input.Number
Hint of maximum value (may be ignored by some clients).
Hint of minimum value (may be ignored by some clients).
Description of the input desired. Displayed when no selection has been made.
Initial value for this field.
Lets a user enter text.
Must be Input.Text
If true, allow multiple lines of input.
Hint of maximum length characters to collect (may be ignored by some clients).
Description of the input desired. Displayed when no text has been input.
Regular expression indicating the required format of this text input.
Style hint for text input.
The initial value for this field.
Lets a user select a time.
Must be Input.Time
Hint of maximum value expressed in HH:MM (may be ignored by some clients).
Hint of minimum value expressed in HH:MM (may be ignored by some clients).
Description of the input desired. Displayed when no time has been selected.
The initial value for this field expressed in HH:MM.
Lets a user choose between two options.
Title for the toggle
Must be Input.Toggle
The initial selected value. If you want the toggle to be initially on, set this to the value of valueOn's value.
The value when toggle is off
The value when toggle is on
If true, allow text to wrap. Otherwise, text is clipped.
Displays a media player for audio or video content.
Array of media sources to attempt to play.
Must be Media
URL of an image to display before playing. Supports data URI in version 1.2+
Alternate text describing the audio or video.
Defines a source for a Media element
Mime type of associated media (e.g. "video/mp4").
URL to media. Supports data URI in version 1.2+
Must be MediaSource
Defines an array of inlines, allowing for inline text formatting.
The array of inlines.
Must be RichTextBlock
Controls the horizontal text alignment. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.
Provides a way to display data in a tabular form.
Must be Table
Defines the number of columns in the table, their sizes, and more.
Defines the rows of the table.
Specifies whether the first row of the table should be treated as a header row, and be announced as such by accessibility software.
Specifies whether grid lines should be displayed.
Defines the style of the grid. This property currently only controls the grid's color.
Controls how the content of all cells is horizontally aligned by default. When not specified, horizontal alignment is defined on a per-cell basis.
Controls how the content of all cells is vertically aligned by default. When not specified, vertical alignment is defined on a per-cell basis.
Represents a cell within a row of a Table element.
The card elements to render inside the TableCell.
Must be TableCell
Style hint for TableCell.
Defines how the content should be aligned vertically within the container. When not specified, the value of verticalContentAlignment is inherited from the parent container. If no parent container has verticalContentAlignment set, it defaults to Top.
Determines whether the element should bleed through its parent's padding.
Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
Specifies the minimum height of the container in pixels, like "80px".
When true content in this container should be presented right to left. When 'false' content in this container should be presented left to right. When unset layout direction will inherit from parent container or column. If unset in all ancestors, the default platform behavior will apply.
Defines the characteristics of a column in a Table element.
Must be TableColumnDefinition
Specifies the width of the column. If expressed as a number, width represents the weight a the column relative to the other columns in the table. If expressed as a string, width must by in the format "
Controls how the content of all cells in the column is horizontally aligned by default. When specified, this value overrides the setting at the table level. When not specified, horizontal alignment is defined at the table, row or cell level.
Controls how the content of all cells in the column is vertically aligned by default. When specified, this value overrides the setting at the table level. When not specified, vertical alignment is defined at the table, row or cell level.
Represents a row of cells within a Table element.
Must be TableRow
The cells in this row. If a row contains more cells than there are columns defined on the Table element, the extra cells are ignored.
Defines the style of the entire row.
Controls how the content of all cells in the row is horizontally aligned by default. When specified, this value overrides both the setting at the table and columns level. When not specified, horizontal alignment is defined at the table, column or cell level.
Controls how the content of all cells in the column is vertically aligned by default. When specified, this value overrides the setting at the table and column level. When not specified, vertical alignment is defined either at the table, column or cell level.
Displays text, allowing control over font sizes, weight, and color.
Text to display. A subset of markdown is supported (https://aka.ms/ACTextFeatures)
Must be TextBlock
Controls the color of TextBlock elements.
Type of font to use for rendering
Controls the horizontal text alignment. When not specified, the value of horizontalAlignment is inherited from the parent container. If no parent container has horizontalAlignment set, it defaults to Left.
If true, displays text slightly toned down to appear less prominent.
Specifies the maximum number of lines to display.
Controls size of text.
Controls the weight of TextBlock elements.
If true, allow text to wrap. Otherwise, text is clipped.
The style of this TextBlock for accessibility purposes.
Determines whether an action is displayed with a button or is moved to the overflow menu.
Controls the style of an Action, which influences how the action is displayed, spoken, etc.
Style hint for Input.ChoiceSet.
Controls how content is horizontally positioned within its container.
Controls the approximate size of the image. The physical dimensions will vary per host. Every option preserves aspect ratio.
Controls how this Image is displayed.
Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.
Controls how a TextBlock behaves.
Style hint for text input.
Defines a button as displayed when prompting a user to authenticate. This maps to the cardAction type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.cardaction).
The type of the button.
The value associated with the button. The meaning of value depends on the button's type.
The caption of the button.
A URL to an image to display alongside the button's caption.
Defines authentication information associated with a card. This maps to the OAuthCard type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.oauthcard)
Must be Authentication
Text that can be displayed to the end user when prompting them to authenticate.
The identifier for registered OAuth connection setting information.
Defines information required to enable on-behalf-of single sign-on user authentication. Maps to the TokenExchangeResource type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.tokenexchangeresource)
4 nested properties
The unique identified of this token exchange instance.
An application ID or resource identifier with which to exchange a token on behalf of. This property is identity provider- and application-specific.
An identifier for the identity provider with which to attempt a token exchange.
Must be TokenExchangeResource
Buttons that should be displayed to the user when prompting for authentication. The array MUST contain one button of type "signin". Other button types are not currently supported.
Specifies a background image. Acceptable formats are PNG, JPEG, and GIF
The URL (or data url) of the image. Acceptable formats are PNG, JPEG, and GIF
Must be BackgroundImage
Controls how content is horizontally positioned within its container.
Defines how a card can be refreshed by making a request to the target Bot.
Must be Refresh
Gathers input fields, merges with optional data field, and sends an event to the client. Clients process the event by sending an Invoke activity of type adaptiveCard/action to the target Bot. The inputs that are gathered are those on the current card, and in the case of a show card those on any parent cards. See Universal Action Model documentation for more details.
13 nested properties
Must be Action.Execute
The card author-defined verb associated with this action.
Initial data that input fields will be combined with. These are essentially ‘hidden’ properties.
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.
Defines information required to enable on-behalf-of single sign-on user authentication. Maps to the TokenExchangeResource type defined by the Bot Framework (https://docs.microsoft.com/dotnet/api/microsoft.bot.schema.tokenexchangeresource)
The unique identified of this token exchange instance.
An application ID or resource identifier with which to exchange a token on behalf of. This property is identity provider- and application-specific.
An identifier for the identity provider with which to attempt a token exchange.
Must be TokenExchangeResource
Label for button or link that represents this action.
Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
A unique identifier associated with this Action.
Controls the style of an Action, which influences how the action is displayed, spoken, etc.
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
Determines whether the action should be enabled.
Determines whether an action is displayed with a button or is moved to the overflow menu.
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
When true, draw a separating line at the top of the element.
Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.
Base input class
Unique identifier for the value. Used to identify collected input when the Submit action is performed.
Error message to display when entered input is invalid
Whether or not this input is required
Label for this input
Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
When true, draw a separating line at the top of the element.
Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.
If false, this item will be removed from the visual tree.
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.
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.
A unique identifier associated with the item.
If false, this item will be removed from the visual tree.