Contact usRequest a demo

Unblu-extended Adaptive Card 1.5 schema

Defines the Adaptive Card format the Unblu Collaboration Server accepts: Microsoft's Adaptive Cards 1.5 schema minus unsupported types, plus Unblu additions. The server rejects unsupported element, input, and action types, and accepts and ignores properties this schema doesn't list.

Adaptive Cards (https://adaptivecards.io) are Microsoft's open JSON format for small pieces of interactive content: text, images, input fields, and buttons that the receiving application renders in its own look and feel.

In Unblu, bots send Adaptive Cards as messages through the web API. The Collaboration Server checks every card against this schema before it is delivered, and the Unblu clients render it in the conversation.

The following web API operations accept a card: /bots/sendMessage and /bots/sendDialogMessage post it as a new message; /bots/editMessage and /bots/editDialogMessage replace the content of a card the bot sent earlier. In all of them, the card is sent as a message of type ADAPTIVE_CARD.

Microsoft's Adaptive Card Designer (https://adaptivecards.io/designer) is a convenient way to draft a card. Unblu doesn't support everything it offers; only the types listed on this page are supported.

Unblu marks an Unblu addition that isn't part of the open-source Adaptive Cards schema; where an addition follows a definition Microsoft publishes outside that schema, its description says so. A Since Unblu 8.44 marker gives the Unblu release from which a type or property is available.

Schema ID https://docs.unblu.com/8/downloads/schemas/unblu-adaptive-card.json

#AdaptiveCardSince Unblu 8.44

NameTypeRequiredSince UnbluDescription
type "AdaptiveCard" Yes 8.44 Must be AdaptiveCard
version string Yes 8.44 Schema version that this card requires. Unblu supports versions 1.0 through 1.5. Example "1.5".
body element[] No 8.44 The card elements to show in the primary card region.
actions action[] No 8.44 The Actions to show in the card's action bar.
selectAction action No 8.44 An Action that will be invoked when the card is tapped or selected. Action.ShowCard is not supported.
fallbackText string No 8.44 Text shown when the client doesn't support the version specified (may contain markdown).
backgroundImage BackgroundImage or string (uri-reference) No 8.44 Specifies the background image of the card.
minHeight string No 8.44 Specifies the minimum height of the card. Example "50px".
rtl boolean No 8.44 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.
speak string No 8.44 Specifies what should be spoken for this entire card. This is simple text or SSML fragment.
lang string No 8.44 The 2-letter ISO-639-1 language used in the card. Used to localize any date/time functions. Example "en", "fr", "es".
verticalContentAlignment VerticalContentAlignment No 8.44 Defines how the content should be aligned vertically within the container. Only relevant for fixed-height cards, or cards with a minHeight specified.
$schema string (uri) No 8.44 The Adaptive Card schema.

Elements

#elementSince Unblu 8.44

A card element of one of the Unblu-supported types. Unsupported types are rejected.

Accepts one of the following, selected by its type property:

#BadgeUnbluSince Unblu 8.44

Displays a compact badge with text. Follows Microsoft's definition without its icon properties: https://adaptivecards.microsoft.com/?topic=Badge

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Badge" Yes 8.44 Must be Badge
text string No 8.44 Text to display in the badge.
size BadgeSize No 8.44 Controls the size of the badge. Default "Medium".
style BadgeStyle No 8.44 Controls the color style of the badge. Default "Default".
appearance BadgeAppearance No 8.44 Controls whether the badge is filled or tinted. Default "Filled".
shape BadgeShape No 8.44 Controls the shape of the badge. Default "Circular".
tooltip string No 8.44 Tooltip shown when hovering over the badge.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#ActionSetSince Unblu 8.44

Displays a set of actions.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "ActionSet" Yes 8.44 Must be ActionSet
actions action[] Yes 8.44 The array of Action elements to show.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#ColumnSetSince Unblu 8.44

ColumnSet divides a region into Columns, allowing elements to sit side-by-side.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "ColumnSet" Yes 8.44 Must be ColumnSet
columns Column[] No 8.44 The array of Columns to divide the region into.
selectAction action No 8.44 An Action that will be invoked when the ColumnSet is tapped or selected. Action.ShowCard is not supported.
style ContainerStyle No 8.44 Style hint for ColumnSet.
bleed boolean No 8.44 Determines whether the element should bleed through its parent's padding.
minHeight string No 8.44 Specifies the minimum height of the column set in pixels, like "80px". Example "50px".
horizontalAlignment HorizontalAlignment No 8.44 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.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#ContainerSince Unblu 8.44

Containers group items together.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Container" Yes 8.44 Must be Container
items element[] Yes 8.44 The card elements to render inside the Container.
selectAction action No 8.44 An Action that will be invoked when the Container is tapped or selected. Action.ShowCard is not supported.
style ContainerStyle No 8.44 Style hint for Container.
verticalContentAlignment VerticalContentAlignment No 8.44 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.
bleed boolean No 8.44 Determines whether the element should bleed through its parent's padding.
backgroundImage BackgroundImage or string (uri-reference) No 8.44 Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
minHeight string No 8.44 Specifies the minimum height of the container in pixels, like "80px". Example "50px".
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.
rtl boolean No 8.44 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.

#FactSetSince Unblu 8.44

The FactSet element displays a series of facts (i.e. name/value pairs) in a tabular form.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "FactSet" Yes 8.44 Must be FactSet
facts Fact[] Yes 8.44 The array of Fact's.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#ImageSince Unblu 8.44

Displays an image. Acceptable formats are PNG, JPEG, and GIF

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Image" Yes 8.44 Must be Image
url string (uri-reference) Yes 8.44 The URL to the image. Supports data URI in version 1.2+
altText string No 8.44 Alternate text describing the image.
backgroundColor string No 8.44 Applies a background to a transparent image. This property will respect the image style. Example "#DDDDDD".
height string or BlockElementHeight No 8.44 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. Default "auto". Example "50px".
horizontalAlignment HorizontalAlignment No 8.44 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.
selectAction action No 8.44 An Action that will be invoked when the Image is tapped or selected. Action.ShowCard is not supported.
size ImageSize No 8.44 Controls the approximate size of the image. The physical dimensions will vary per host.
style ImageStyle No 8.44 Controls how this Image is displayed.
width string No 8.44 The desired on-screen width of the image, ending in 'px'. E.g., 50px. This overrides the size property. Example "50px".
fallback element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
separator boolean No 8.44 When true, draw a separating line at the top of the element.
spacing Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id string No 8.44 A unique identifier associated with the item.
isVisible boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires object of string No 8.44 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.
targetWidthUnblu TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#ImageSetSince Unblu 8.44

The ImageSet displays a collection of Images similar to a gallery. Acceptable formats are PNG, JPEG, and GIF

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "ImageSet" Yes 8.44 Must be ImageSet
images Image[] Yes 8.44 The array of Image elements to show.
imageSize ImageSize No 8.44 Controls the approximate size of each image. The physical dimensions will vary per host. Auto and stretch are not supported for ImageSet. The size will default to medium if those values are set. Default "medium".
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#MediaSince Unblu 8.44

Displays a media player for audio or video content.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Media" Yes 8.44 Must be Media
sources MediaSource[] Yes 8.44 Array of media sources to attempt to play.
poster string (uri-reference) No 8.44 URL of an image to display before playing. Supports data URI in version 1.2+
altText string No 8.44 Alternate text describing the audio or video.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#RichTextBlockSince Unblu 8.44

Defines an array of inlines, allowing for inline text formatting.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "RichTextBlock" Yes 8.44 Must be RichTextBlock
inlines Inline[] Yes 8.44 The array of inlines.
horizontalAlignment HorizontalAlignment No 8.44 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.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#TableSince Unblu 8.44

Provides a way to display data in a tabular form.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Table" Yes 8.44 Must be Table
columns TableColumnDefinition[] No 8.44 Defines the number of columns in the table, their sizes, and more.
rows TableRow[] No 8.44 Defines the rows of the table.
firstRowAsHeader boolean No 8.44 Specifies whether the first row of the table should be treated as a header row, and be announced as such by accessibility software. Default true.
showGridLines boolean No 8.44 Specifies whether grid lines should be displayed. Default true.
gridStyle ContainerStyle No 8.44 Defines the style of the grid. This property currently only controls the grid's color. Default "default".
horizontalCellContentAlignment HorizontalAlignment No 8.44 Controls how the content of all cells is horizontally aligned by default. When not specified, horizontal alignment is defined on a per-cell basis.
verticalCellContentAlignment VerticalAlignment No 8.44 Controls how the content of all cells is vertically aligned by default. When not specified, vertical alignment is defined on a per-cell basis.
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#TextBlockSince Unblu 8.44

Displays text, allowing control over font sizes, weight, and color.

Inherits from Extendable.Element.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "TextBlock" Yes 8.44 Must be TextBlock
text string Yes 8.44 Text to display. A subset of markdown is supported (https://aka.ms/ACTextFeatures)
color Colors No 8.44 Controls the color of TextBlock elements.
fontType FontType No 8.44 Type of font to use for rendering
horizontalAlignment HorizontalAlignment No 8.44 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.
isSubtle boolean No 8.44 If true, displays text slightly toned down to appear less prominent. Default false.
maxLines number No 8.44 Specifies the maximum number of lines to display.
size FontSize No 8.44 Controls size of text.
weight FontWeight No 8.44 Controls the weight of TextBlock elements.
wrap boolean No 8.44 If true, allow text to wrap. Otherwise, text is clipped. Default false.
style TextBlockStyle No 8.44 The style of this TextBlock for accessibility purposes. Default "default".
fallback from Extendable.Element element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Element BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Element boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Element Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu from Extendable.Element TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.ChoiceSetSince Unblu 8.44

Allows a user to input a Choice.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.ChoiceSet" Yes 8.44 Must be Input.ChoiceSet
choices Input.Choice[] No 8.44 Choice options.
isMultiSelect boolean No 8.44 Allow multiple choices to be selected. Default false.
style ChoiceInputStyle No 8.44 —
value string No 8.44 The initial choice (or set of choices) that should be selected. For multi-select, specify a comma-separated string of values.
placeholder string No 8.44 Description of the input desired. Only visible when no selection has been made, the style is compact and isMultiSelect is false
wrap boolean No 8.44 If true, allow text to wrap. Otherwise, text is clipped.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.DateSince Unblu 8.44

Lets a user choose a date.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.Date" Yes 8.44 Must be Input.Date
max string No 8.44 Hint of maximum value expressed in YYYY-MM-DD(may be ignored by some clients).
min string No 8.44 Hint of minimum value expressed in YYYY-MM-DD(may be ignored by some clients).
placeholder string No 8.44 Description of the input desired. Displayed when no selection has been made.
value string No 8.44 The initial value for this field expressed in YYYY-MM-DD.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.NumberSince Unblu 8.44

Allows a user to enter a number.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.Number" Yes 8.44 Must be Input.Number
max number No 8.44 Hint of maximum value (may be ignored by some clients).
min number No 8.44 Hint of minimum value (may be ignored by some clients).
placeholder string No 8.44 Description of the input desired. Displayed when no selection has been made.
value number No 8.44 Initial value for this field.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.TextSince Unblu 8.44

Lets a user enter text.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.Text" Yes 8.44 Must be Input.Text
isMultiline boolean No 8.44 If true, allow multiple lines of input. Default false.
maxLength number No 8.44 Hint of maximum length characters to collect (may be ignored by some clients).
placeholder string No 8.44 Description of the input desired. Displayed when no text has been input.
regex string No 8.44 Regular expression indicating the required format of this text input.
style TextInputStyle No 8.44 Style hint for text input.
inlineAction action No 8.44 The inline action for the input. Typically displayed to the right of the input. It is strongly recommended to provide an icon on the action (which will be displayed instead of the title of the action).
value string No 8.44 The initial value for this field.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.TimeSince Unblu 8.44

Lets a user select a time.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.Time" Yes 8.44 Must be Input.Time
max string No 8.44 Hint of maximum value expressed in HH:MM (may be ignored by some clients).
min string No 8.44 Hint of minimum value expressed in HH:MM (may be ignored by some clients).
placeholder string No 8.44 Description of the input desired. Displayed when no time has been selected.
value string No 8.44 The initial value for this field expressed in HH:MM.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Input.ToggleSince Unblu 8.44

Lets a user choose between two options.

Inherits from Extendable.Input.

Accepted wherever element is allowed.

NameTypeRequiredSince UnbluDescription
type "Input.Toggle" Yes 8.44 Must be Input.Toggle
title string Yes 8.44 Title for the toggle
value string No 8.44 The initial selected value. If you want the toggle to be initially on, set this to the value of valueOn's value. Default "false".
valueOff string No 8.44 The value when toggle is off Default "false".
valueOn string No 8.44 The value when toggle is on Default "true".
wrap boolean No 8.44 If true, allow text to wrap. Otherwise, text is clipped.
id from Extendable.Input string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage from Extendable.Input string No 8.44 Error message to display when entered input is invalid
isRequired from Extendable.Input boolean No 8.44 Whether or not this input is required
label from Extendable.Input string No 8.44 Label for this input
fallback from Extendable.Input element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height from Extendable.Input BlockElementHeight No 8.44 Specifies the height of the element.
separator from Extendable.Input boolean No 8.44 When true, draw a separating line at the top of the element.
spacing from Extendable.Input Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible from Extendable.Input boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Input object of string No 8.44 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.
targetWidthUnblu from Extendable.Input TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

Actions

#actionSince Unblu 8.44

An action of one of the Unblu-supported types. Action.ShowCard isn't supported.

Accepts one of the following, selected by its type property:

#Action.ExecuteSince Unblu 8.44

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.

Inherits from Extendable.Action.

Accepted wherever action is allowed.

NameTypeRequiredSince UnbluDescription
type "Action.Execute" Yes 8.44 Must be Action.Execute
verb string No 8.44 The card author-defined verb associated with this action.
data string or object No 8.44 Data the card author attaches to the action. When the action is executed, the data is merged with the values of the card's input elements and reported untouched to webhook subscribers and to the dialog bot that sent the card.
associatedInputs AssociatedInputs No 8.44 Controls which inputs are associated with the action. Default "auto".
title from Extendable.Action string No 8.44 Label for button or link that represents this action.
iconUrl from Extendable.Action string (uri-reference) No 8.44 Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
id from Extendable.Action string No 8.44 A unique identifier associated with this Action.
style from Extendable.Action ActionStyle No 8.44 Controls the style of an Action, which influences how the action is displayed, spoken, etc.
fallback from Extendable.Action action or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
tooltip from Extendable.Action string No 8.44 Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
isEnabled from Extendable.Action boolean No 8.44 Determines whether the action should be enabled. Default true.
mode from Extendable.Action ActionMode No 8.44 Determines whether the action should be displayed as a button or in the overflow menu. Default "primary".
requires from Extendable.Item object of string No 8.44 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.
unbluInstructionsUnblu Unblu.Instructions No 8.44 Instructions the Collaboration Server executes when a participant triggers this action.

#Action.OpenUrlSince Unblu 8.44

When invoked, show the given url either by launching it in an external web browser or showing within an embedded web browser.

Inherits from Extendable.Action.

Accepted wherever action is allowed.

NameTypeRequiredSince UnbluDescription
type "Action.OpenUrl" Yes 8.44 Must be Action.OpenUrl
url string (uri-reference) Yes 8.44 The URL to open.
title from Extendable.Action string No 8.44 Label for button or link that represents this action.
iconUrl from Extendable.Action string (uri-reference) No 8.44 Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
id from Extendable.Action string No 8.44 A unique identifier associated with this Action.
style from Extendable.Action ActionStyle No 8.44 Controls the style of an Action, which influences how the action is displayed, spoken, etc.
fallback from Extendable.Action action or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
tooltip from Extendable.Action string No 8.44 Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
isEnabled from Extendable.Action boolean No 8.44 Determines whether the action should be enabled. Default true.
mode from Extendable.Action ActionMode No 8.44 Determines whether the action should be displayed as a button or in the overflow menu. Default "primary".
requires from Extendable.Item object of string No 8.44 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.

#Action.SubmitSince Unblu 8.44

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.

Inherits from Extendable.Action.

Accepted wherever action is allowed.

NameTypeRequiredSince UnbluDescription
type "Action.Submit" Yes 8.44 Must be Action.Submit
data string or object No 8.44 Data the card author attaches to the action. When the action is executed, the data is merged with the values of the card's input elements and reported untouched to webhook subscribers and to the dialog bot that sent the card.
associatedInputs AssociatedInputs No 8.44 Controls which inputs are associated with the submit action. Default "auto".
title from Extendable.Action string No 8.44 Label for button or link that represents this action.
iconUrl from Extendable.Action string (uri-reference) No 8.44 Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
id from Extendable.Action string No 8.44 A unique identifier associated with this Action.
style from Extendable.Action ActionStyle No 8.44 Controls the style of an Action, which influences how the action is displayed, spoken, etc.
fallback from Extendable.Action action or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
tooltip from Extendable.Action string No 8.44 Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
isEnabled from Extendable.Action boolean No 8.44 Determines whether the action should be enabled. Default true.
mode from Extendable.Action ActionMode No 8.44 Determines whether the action should be displayed as a button or in the overflow menu. Default "primary".
requires from Extendable.Item object of string No 8.44 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.
unbluInstructionsUnblu Unblu.Instructions No 8.44 Instructions the Collaboration Server executes when a participant triggers this action.

#Action.ToggleVisibilitySince Unblu 8.44

An action that toggles the visibility of associated card elements.

Inherits from Extendable.Action.

Accepted wherever action is allowed.

NameTypeRequiredSince UnbluDescription
type "Action.ToggleVisibility" Yes 8.44 Must be Action.ToggleVisibility
targetElements TargetElement[] Yes 8.44 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.
title from Extendable.Action string No 8.44 Label for button or link that represents this action.
iconUrl from Extendable.Action string (uri-reference) No 8.44 Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
id from Extendable.Action string No 8.44 A unique identifier associated with this Action.
style from Extendable.Action ActionStyle No 8.44 Controls the style of an Action, which influences how the action is displayed, spoken, etc.
fallback from Extendable.Action action or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
tooltip from Extendable.Action string No 8.44 Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
isEnabled from Extendable.Action boolean No 8.44 Determines whether the action should be enabled. Default true.
mode from Extendable.Action ActionMode No 8.44 Determines whether the action should be displayed as a button or in the overflow menu. Default "primary".
requires from Extendable.Item object of string No 8.44 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.

Enums

#ActionModeSince Unblu 8.44

Determines whether an action is displayed with a button or is moved to the overflow menu.

  • primary
  • secondary

Values are case-insensitive.

#ActionStyleSince Unblu 8.44

Controls the style of an Action, which influences how the action is displayed, spoken, etc.

  • default
  • positive
  • destructive

Values are case-insensitive.

#AssociatedInputsSince Unblu 8.44

  • Auto
  • None

Values are case-insensitive.

#BadgeAppearanceUnbluSince Unblu 8.44

Whether a Badge is filled or tinted.

  • Filled
  • Tint

Values are case-insensitive.

#BadgeShapeUnbluSince Unblu 8.44

Shape of a Badge.

  • Square
  • Rounded
  • Circular

Values are case-insensitive.

#BadgeSizeUnbluSince Unblu 8.44

Size of a Badge.

  • Medium
  • Large
  • ExtraLarge

Values are case-insensitive.

#BadgeStyleUnbluSince Unblu 8.44

Color style of a Badge.

  • Default
  • Subtle
  • Informative
  • Accent
  • Good
  • Attention
  • Warning

Values are case-insensitive.

#BlockElementHeightSince Unblu 8.44

  • auto
  • stretch

Values are case-insensitive.

#ChoiceInputStyleSince Unblu 8.44

Style hint for Input.ChoiceSet.

  • compact
  • expanded

Values are case-insensitive.

#ColorsSince Unblu 8.44

  • default
  • dark
  • light
  • accent
  • good
  • warning
  • attention

Values are case-insensitive.

#ContainerStyleSince Unblu 8.44

  • default
  • emphasis
  • good
  • attention
  • warning
  • accent

Values are case-insensitive.

#FallbackOptionSince Unblu 8.44

  • drop

Values are case-insensitive.

#FontSizeSince Unblu 8.44

  • default
  • small
  • medium
  • large
  • extraLarge

Values are case-insensitive.

#FontTypeSince Unblu 8.44

  • default
  • monospace

Values are case-insensitive.

#FontWeightSince Unblu 8.44

  • default
  • lighter
  • bolder

Values are case-insensitive.

#HorizontalAlignmentSince Unblu 8.44

Controls how content is horizontally positioned within its container.

  • left
  • center
  • right

Values are case-insensitive.

#ImageFillModeSince Unblu 8.44

  • cover
  • repeatHorizontally
  • repeatVertically
  • repeat

Values are case-insensitive.

#ImageSizeSince Unblu 8.44

Controls the approximate size of the image. The physical dimensions will vary per host. Every option preserves aspect ratio.

  • auto
  • stretch
  • small
  • medium
  • large

Values are case-insensitive.

#ImageStyleSince Unblu 8.44

Controls how this Image is displayed.

  • default
  • person

Values are case-insensitive.

#SpacingSince Unblu 8.44

Specifies how much spacing. Hosts pick the exact pixel amounts for each of these.

  • default
  • none
  • small
  • medium
  • large
  • extraLarge
  • padding

Values are case-insensitive.

#TargetWidthUnbluSince Unblu 8.44

Width of the conversation's message list, not of the card itself, at which an element is displayed. A bare width names exactly that range; atLeast: and atMost: turn it into an open-ended range. The ranges are bounded by three breakpoints, each set by a configuration property: Narrow by com.unblu.adaptivecard.ui.containerWidthNarrow, Standard by com.unblu.adaptivecard.ui.containerWidthStandard, and Wide by com.unblu.adaptivecard.ui.containerWidthWide. Based on Microsoft's definition: https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-format#adaptive-card-responsive-layout

ValueDescription
VeryNarrowBelow the Narrow breakpoint
NarrowFrom the Narrow breakpoint to just below the Standard breakpoint
StandardFrom the Standard breakpoint to just below the Wide breakpoint
WideThe Wide breakpoint and up
atLeast:VeryNarrowAll widths
atLeast:NarrowThe Narrow breakpoint and up
atLeast:StandardThe Standard breakpoint and up
atLeast:WideThe Wide breakpoint and up
atMost:VeryNarrowBelow the Narrow breakpoint
atMost:NarrowBelow the Standard breakpoint
atMost:StandardBelow the Wide breakpoint
atMost:WideAll widths

Values are case-insensitive.

#TextBlockStyleSince Unblu 8.44

Controls how a TextBlock behaves.

  • default
  • heading

Values are case-insensitive.

#TextInputStyleSince Unblu 8.44

Style hint for text input.

  • text
  • tel
  • url
  • email
  • password

Values are case-insensitive.

#VerticalAlignmentSince Unblu 8.44

  • top
  • center
  • bottom

Values are case-insensitive.

#VerticalContentAlignmentSince Unblu 8.44

  • top
  • center
  • bottom

Values are case-insensitive.

Other types

#BackgroundImageSince Unblu 8.44

Specifies a background image. Acceptable formats are PNG, JPEG, and GIF

NameTypeRequiredSince UnbluDescription
type "BackgroundImage" No 8.44 Must be BackgroundImage
url string (uri-reference) Yes 8.44 The URL (or data url) of the image. Acceptable formats are PNG, JPEG, and GIF
fillMode ImageFillMode No 8.44 Describes how the image should fill the area.
horizontalAlignment HorizontalAlignment No 8.44 Describes how the image should be aligned if it must be cropped or if using repeat fill mode.
verticalAlignment VerticalAlignment No 8.44 Describes how the image should be aligned if it must be cropped or if using repeat fill mode.

#ColumnSince Unblu 8.44

Defines a container that is part of a ColumnSet.

Inherits from Extendable.ToggleableItem.

NameTypeRequiredSince UnbluDescription
type "Column" No 8.44 Must be Column
items element[] No 8.44 The card elements to render inside the Column.
backgroundImage BackgroundImage or string (uri-reference) No 8.44 Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
bleed boolean No 8.44 Determines whether the column should bleed through its parent's padding.
fallback Column or FallbackOption No 8.44 Describes what to do when an unknown item is encountered or the requires of this or any children can't be met.
minHeight string No 8.44 Specifies the minimum height of the column in pixels, like "80px". Example "50px".
rtl boolean No 8.44 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.
separator boolean No 8.44 When true, draw a separating line between this column and the previous column.
spacing Spacing No 8.44 Controls the amount of spacing between this column and the preceding column.
selectAction action No 8.44 An Action that will be invoked when the Column is tapped or selected. Action.ShowCard is not supported.
style ContainerStyle No 8.44 Style hint for Column.
verticalContentAlignment VerticalContentAlignment No 8.44 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.
width string or number No 8.44 "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".
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Extendable.ActionSince Unblu 8.44

Inherits from Extendable.Item.

NameTypeRequiredSince UnbluDescription
title string No 8.44 Label for button or link that represents this action.
iconUrl string (uri-reference) No 8.44 Optional icon to be shown on the action in conjunction with the title. Supports data URI in version 1.2+
id string No 8.44 A unique identifier associated with this Action.
style ActionStyle No 8.44 Controls the style of an Action, which influences how the action is displayed, spoken, etc.
fallback action or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
tooltip string No 8.44 Defines text that should be displayed to the end user as they hover the mouse over the action, and read when using narration software.
isEnabled boolean No 8.44 Determines whether the action should be enabled. Default true.
mode ActionMode No 8.44 Determines whether the action should be displayed as a button or in the overflow menu. Default "primary".
requires from Extendable.Item object of string No 8.44 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.

#Extendable.ElementSince Unblu 8.44

Inherits from Extendable.ToggleableItem.

NameTypeRequiredSince UnbluDescription
fallback element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height BlockElementHeight No 8.44 Specifies the height of the element.
separator boolean No 8.44 When true, draw a separating line at the top of the element.
spacing Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
id from Extendable.ToggleableItem string No 8.44 A unique identifier associated with the item.
isVisible from Extendable.ToggleableItem boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.
targetWidthUnblu TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Extendable.InputSince Unblu 8.44

Base input class

NameTypeRequiredSince UnbluDescription
id string Yes 8.44 Unique identifier for the value. Used to identify collected input when the Submit action is performed.
errorMessage string No 8.44 Error message to display when entered input is invalid
isRequired boolean No 8.44 Whether or not this input is required
label string No 8.44 Label for this input
fallback element or FallbackOption No 8.44 Describes what to do when an unknown element is encountered or the requires of this or any children can't be met.
height BlockElementHeight No 8.44 Specifies the height of the element.
separator boolean No 8.44 When true, draw a separating line at the top of the element.
spacing Spacing No 8.44 Controls the amount of spacing between this element and the preceding element.
isVisible boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires object of string No 8.44 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.
targetWidthUnblu TargetWidth No 8.44 Controls the message list widths at which the element is displayed. If not set, the element is displayed at all widths.

#Extendable.ItemSince Unblu 8.44

NameTypeRequiredSince UnbluDescription
requires object of string No 8.44 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.

#Extendable.ToggleableItemSince Unblu 8.44

Inherits from Extendable.Item.

NameTypeRequiredSince UnbluDescription
id string No 8.44 A unique identifier associated with the item.
isVisible boolean No 8.44 If false, this item will be removed from the visual tree. Default true.
requires from Extendable.Item object of string No 8.44 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.

#FactSince Unblu 8.44

Describes a Fact in a FactSet as a key/value pair.

NameTypeRequiredSince UnbluDescription
type "Fact" No 8.44 Must be Fact
title string Yes 8.44 The title of the fact.
value string Yes 8.44 The value of the fact.

#InlineSince Unblu 8.44

Accepts one of:

#Input.ChoiceSince Unblu 8.44

Describes a choice for use in a ChoiceSet.

NameTypeRequiredSince UnbluDescription
type "Input.Choice" No 8.44 Must be Input.Choice
title string Yes 8.44 Text to display.
value string Yes 8.44 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.

#MediaSourceSince Unblu 8.44

Defines a source for a Media element

NameTypeRequiredSince UnbluDescription
type "MediaSource" No 8.44 Must be MediaSource
mimeType string Yes 8.44 Mime type of associated media (e.g. "video/mp4").
url string (uri-reference) Yes 8.44 URL to media. Supports data URI in version 1.2+

#TableCellSince Unblu 8.44

Represents a cell within a row of a Table element.

NameTypeRequiredSince UnbluDescription
type "TableCell" No 8.44 Must be TableCell
items element[] Yes 8.44 The card elements to render inside the TableCell.
selectAction action No 8.44 An Action that will be invoked when the TableCell is tapped or selected. Action.ShowCard is not supported.
style ContainerStyle No 8.44 Style hint for TableCell.
verticalContentAlignment VerticalContentAlignment No 8.44 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.
bleed boolean No 8.44 Determines whether the element should bleed through its parent's padding.
backgroundImage BackgroundImage or string (uri-reference) No 8.44 Specifies the background image. Acceptable formats are PNG, JPEG, and GIF
minHeight string No 8.44 Specifies the minimum height of the container in pixels, like "80px". Example "50px".
rtl? boolean No 8.44 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.

#TableColumnDefinitionSince Unblu 8.44

Defines the characteristics of a column in a Table element.

NameTypeRequiredSince UnbluDescription
type "TableColumnDefinition" No 8.44 Must be TableColumnDefinition
width string or number No 8.44 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 "<number>px" (for instance, "50px") and represents an explicit number of pixels. Default 1.
horizontalCellContentAlignment HorizontalAlignment No 8.44 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.
verticalCellContentAlignment VerticalAlignment No 8.44 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.

#TableRowSince Unblu 8.44

Represents a row of cells within a Table element.

NameTypeRequiredSince UnbluDescription
type "TableRow" No 8.44 Must be TableRow
cells TableCell[] No 8.44 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.
style ContainerStyle No 8.44 Defines the style of the entire row.
horizontalCellContentAlignment HorizontalAlignment No 8.44 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.
verticalCellContentAlignment VerticalAlignment No 8.44 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.

#TargetElementSince Unblu 8.44

Represents an entry for Action.ToggleVisibility's targetElements property

May also be written as a plain string. Element ID of element to toggle

NameTypeRequiredSince UnbluDescription
type "TargetElement" No 8.44 Must be TargetElement
elementId string Yes 8.44 Element ID of element to toggle
isVisible boolean No 8.44 If true, always show target element. If false, always hide target element. If not supplied, toggle target element's visibility.

#TextRunSince Unblu 8.44

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.

May also be written as a plain string. Text to display. Markdown is not supported.

NameTypeRequiredSince UnbluDescription
type "TextRun" Yes 8.44 Must be TextRun
text string Yes 8.44 Text to display. Markdown is not supported.
color Colors No 8.44 Controls the color of the text.
fontType FontType No 8.44 The type of font to use
highlight boolean No 8.44 If true, displays the text highlighted.
isSubtle boolean No 8.44 If true, displays text slightly toned down to appear less prominent. Default false.
italic boolean No 8.44 If true, displays the text using italic font.
selectAction action No 8.44 Action to invoke when this text run is clicked. Visually changes the text run into a hyperlink. Action.ShowCard is not supported.
size FontSize No 8.44 Controls size of text.
strikethrough boolean No 8.44 If true, displays the text with strikethrough.
underline boolean No 8.44 If true, displays the text with an underline.
weight FontWeight No 8.44 Controls the weight of the text.

#Unblu.InstructionsUnbluSince Unblu 8.44

An Unblu-specific instruction that the Collaboration Server executes when a participant triggers the action, for example posting a response message in the name of that participant. Note: An action that declares instructions must also carry an id. A card whose instructions are unknown or malformed is rejected when it is posted.

NameTypeRequiredSince UnbluDescription
sendMessage object No 8.44 Posts a message in the name of the participant who triggered the action. The value is a PostMessageData as the web API defines it, carrying the message content only; REPLY and WHATS_APP_TEMPLATE messages can't be declared.