Elemento de AdaptiveCard

Esta página documenta el AdaptiveCard elemento , que es el elemento raíz de una tarjeta adaptable.

Nota importante sobre la accesibilidad: En la versión 1.3 del esquema se introdujo una propiedad label en Entradas para mejorar la accesibilidad. Si la aplicación anfitriona a la que está orientando admite la versión 1.3, debe usar etiqueta en lugar de TextBlock, como se muestra en algunos ejemplos a continuación. Una vez que la mayoría de las aplicaciones host se hayan actualizado a la versión más reciente, actualizaremos los ejemplos según corresponda.

AdaptiveCard

Tarjeta adaptable, que contiene un cuerpo de forma libre de elementos de tarjeta y un conjunto opcional de acciones.

Propiedades de AdaptiveCard

Example

Ejemplo básico de AdaptiveCard (JSON)

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.0",
	"body": [
		{
			"type": "Container",
			"items": [
				{
					"type": "TextBlock",
					"text": "Publish Adaptive Card schema",
					"weight": "bolder",
					"size": "medium"
				},
				{
					"type": "ColumnSet",
					"columns": [
						{
							"type": "Column",
							"width": "auto",
							"items": [
								{
									"type": "Image",
									"url": "https://pbs.twimg.com/profile_images/3647943215/d7f12830b3c17a5a9e4afcc370e3a37e_400x400.jpeg",
									"altText": "Matt Hidinger",
									"size": "small",
									"style": "person"
								}
							]
						},
						{
							"type": "Column",
							"width": "stretch",
							"items": [
								{
									"type": "TextBlock",
									"text": "Matt Hidinger",
									"weight": "bolder",
									"wrap": true
								},
								{
									"type": "TextBlock",
									"spacing": "none",
									"text": "Created {{DATE(2017-02-14T06:08:39Z, SHORT)}}",
									"isSubtle": true,
									"wrap": true
								}
							]
						}
					]
				}
			]
		},
		{
			"type": "Container",
			"items": [
				{
					"type": "TextBlock",
					"text": "Now that we have defined the main rules and features of the format, we need to produce a schema and publish it to GitHub. The schema will be the starting point of our reference documentation.",
					"wrap": true
				},
				{
					"type": "FactSet",
					"facts": [
						{
							"title": "Board:",
							"value": "Adaptive Card"
						},
						{
							"title": "List:",
							"value": "Backlog"
						},
						{
							"title": "Assigned to:",
							"value": "Matt Hidinger"
						},
						{
							"title": "Due date:",
							"value": "Not set"
						}
					]
				}
			]
		}
	],
	"actions": [
		{
			"type": "Action.ShowCard",
			"title": "Comment",
			"card": {
				"type": "AdaptiveCard",
				"body": [
					{
						"type": "Input.Text",
						"id": "comment",
						"isMultiline": true,
						"placeholder": "Enter your comment"
					}
				],
				"actions": [
					{
						"type": "Action.Submit",
						"title": "OK"
					}
				]
			}
		},
		{
			"type": "Action.OpenUrl",
			"title": "View",
			"url": "https://adaptivecards.io"
		}
	]
}

Propiedades

version

Versión de esquema que requiere esta tarjeta. Si un cliente es inferior a esta versión, fallbackText se representará . NOTA: La versión no es necesaria para las tarjetas dentro de Action.ShowCard. Sin embargo, es necesario para la tarjeta de nivel superior.

• Tipo: string
• Obligatorio: No

actualizar

Define cómo se puede actualizar la tarjeta realizando una solicitud al bot de destino.

• Tipo: Refresh
• Versión: 1.4
• Obligatorio: No
• Valores permitidos:
  • Refresh

Ejemplo de actualización (JSON)

{
	"type": "AdaptiveCard",
	"version": "1.3",
	"refresh": {
		"action": {
			"type": "Action.Execute",
			"verb": "refreshCard"
		},
		"userIds": [
			"user1",
			"user2"
		]
	},
	"body": [
		{
			"type": "TextBlock",
			"text": "This is a card that will be refreshed."
		}
	]
}

autenticación

Define la información de autenticación para habilitar el inicio de sesión único en nombre de otros o OAuth justo a tiempo.

• Tipo: Authentication
• Versión: 1.4
• Obligatorio: No
• Valores permitidos:
  • Authentication

Ejemplo de autenticación (JSON)

{
	"type": "AdaptiveCard",
	"version": "1.4",
	"authentication": {
		"connectionName": "myConnection",
		"text": "Please Authenticate your account",
		"tokenExchangeResource": {
			"id": "myTokenId",
			"providerId": "myProviderId",
			"uri": "https: //mytoken.exchange/resource"
		},
		"buttons": [
			{
				"type": "signin",
				"title": "Click here to Sign In!"
			}
		]
	},
	"body": [
		{
			"type": "TextBlock",
			"text": "This is a card that has authentication"
		}
	]
}

body

Elementos de tarjeta que se van a mostrar en la región de la tarjeta primaria.

• Tipo: Element[]
• Obligatorio: No
• Valores permitidos:
  • ActionSet
  • ColumnSet
  • Container
  • FactSet
  • Image
  • ImageSet
  • Input.ChoiceSet
  • Input.Date
  • Input.Number
  • Input.Text
  • Input.Time
  • Input.Toggle
  • Media
  • RichTextBlock
  • Table
  • TextBlock

Acciones

Acciones que se van a mostrar en la barra de acciones de la tarjeta.

• Tipo: Action[]
• Obligatorio: No
• Valores permitidos:
  • Action.Execute
  • Action.OpenUrl
  • Action.ShowCard
  • Action.Submit
  • Action.ToggleVisibility

seleccionarAcción

Acción que se invocará cuando se pulse o seleccione la tarjeta. No se admite Action.ShowCard.

• Tipo: ISelectAction
• Versión: 1.1
• Obligatorio: No
• Valores permitidos:
  • Action.Execute
  • Action.OpenUrl
  • Action.Submit
  • Action.ToggleVisibility

fallbackText

Texto que se muestra cuando el cliente no admite la versión especificada (puede contener Markdown).

• Tipo: string
• Obligatorio: No

backgroundImage

Especifica la imagen de fondo de la tarjeta.

• Tipo: BackgroundImage, uri
• Versión: 1.2, 1.0
• Obligatorio: No
• Valores permitidos:
  • BackgroundImage
  • uri

metadata

Define varias propiedades de metadatos que normalmente no se usan para representar la tarjeta.

• Tipo: Metadata
• Versión: 1.6
• Obligatorio: No
• Valores permitidos:
  • Metadata

altura mínima

Especifica la altura mínima de la tarjeta.

• Tipo: string
• Versión: 1.2
• Obligatorio: No

Ejemplo minHeight (JSON)

{
	"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
	"type": "AdaptiveCard",
	"version": "1.2",
	"minHeight": "100px",
	"body": [
		{
			"type": "TextBlock",
			"wrap": true,
			"text": "This card has a minHeight of 100px"
		}
	]
}

Rtl

Cuando el contenido de true en esta tarjeta adaptable deba presentarse de derecha a izquierda. Cuando el contenido "false" de esta tarjeta adaptable se debe presentar de izquierda a derecha. Si no se establece, se aplicará el comportamiento predeterminado de la plataforma.

• Tipo: boolean?
• Versión: 1.5
• Obligatorio: No

Ejemplo rtl (JSON)

{
  "type": "AdaptiveCard",
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "version": "1.5",
  "rtl": true,
  "body": [
    {
      "type": "TextBlock",
      "text": "هذه كتلة نص",
      "wrap": true
    },
    {
      "type": "TextBlock",
      "text": "זהו בלוק טקסט",
      "wrap": true
    },
    {
      "type": "TextBlock",
      "text": "This is a text block",
      "wrap": true
    }
  ]
}

leer

Especifica lo que se debe decir para toda esta tarjeta. Se trata de texto simple o fragmento SSML.

• Tipo: string
• Obligatorio: No

lang

Idioma ISO-639-1 de 2 letras utilizado en la tarjeta. Se usa para localizar cualquier función de fecha y hora.

• Tipo: string
• Obligatorio: No

alineaciónVerticalDelContenido

Define cómo se debe alinear el contenido verticalmente dentro del contenedor. Solo es relevante para las tarjetas de altura fija o tarjetas con un minHeight especificado.

• Tipo: VerticalContentAlignment
• Versión: 1.1
• Obligatorio: No
• Valores permitidos:
  • "top"
  • "center"
  • "bottom"

$schema

Esquema de tarjeta adaptable.

• Tipo: uri
• Obligatorio: No