AdaptiveCard-Element

Diese Seite dokumentiert das AdaptiveCard Element, bei dem es sich um das Stammelement einer adaptiven Karte handelt.

Wichtiger Hinweis zur Barrierefreiheit: In Version 1.3 des Schemas haben wir eine Bezeichnungseigenschaft für Eingaben eingeführt, um die Barrierefreiheit zu verbessern. Wenn die Host-App, auf die Sie abzielen , v1.3 unterstützt, sollten Sie die Bezeichnung anstelle eines TextBlock verwenden, wie in einigen Beispielen unten dargestellt. Sobald die meisten Host-Apps auf die neueste Version aktualisiert wurden, aktualisieren wir die Beispiele entsprechend.

AdaptiveCard

Eine adaptive Karte, die einen frei gestaltbaren Körper aus Kartenelementen und einen optionalen Satz von Aktionen enthält.

AdaptiveCard-Eigenschaften

Example

Einfaches AdaptiveCard-Beispiel (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"
		}
	]
}

Eigenschaften

Ausgabe

Schemaversion, die für diese Karte erforderlich ist. Wenn ein Client niedriger ist, als diese Version, wird fallbackText gerendert. HINWEIS: Die Version ist für Karten in einem Action.ShowCard nicht erforderlich. Es ist jedoch für die Karte der obersten Ebene erforderlich.

• Typ: string
• Erforderlich: Nein

Aktualisieren

Definiert, wie die Karte aktualisiert werden kann, indem eine Anforderung an den Zielbot gestellt wird.

• Typ: Refresh
• Version: 1.4
• Erforderlich: Nein
• Zulässige Werte:
  • Refresh

Beispiel aktualisieren (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."
		}
	]
}

Authentifizierung

Definiert Authentifizierungsinformationen, um einmaliges Anmelden oder Just-in-Time-OAuth zu aktivieren.

• Typ: Authentication
• Version: 1.4
• Erforderlich: Nein
• Zulässige Werte:
  • Authentication

Authentifizierungsbeispiel (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

Die Kartenelemente, die im primären Kartenbereich angezeigt werden sollen.

• Typ: Element[]
• Erforderlich: Nein
• Zulässige Werte:
  • ActionSet
  • ColumnSet
  • Container
  • FactSet
  • Image
  • ImageSet
  • Input.ChoiceSet
  • Input.Date
  • Input.Number
  • Input.Text
  • Input.Time
  • Input.Toggle
  • Media
  • RichTextBlock
  • Table
  • TextBlock

Handlungen

Die Aktionen, die in der Aktionsleiste der Karte angezeigt werden sollen.

• Typ: Action[]
• Erforderlich: Nein
• Zulässige Werte:
  • Action.Execute
  • Action.OpenUrl
  • Action.ShowCard
  • Action.Submit
  • Action.ToggleVisibility

selectAction

Eine Aktion, die aufgerufen wird, wenn die Karte angetippt oder ausgewählt wird. Action.ShowCard wird nicht unterstützt.

• Typ: ISelectAction
• Version: 1.1
• Erforderlich: Nein
• Zulässige Werte:
  • Action.Execute
  • Action.OpenUrl
  • Action.Submit
  • Action.ToggleVisibility

Ersatztext

Text, der angezeigt wird, wenn der Client die angegebene Version nicht unterstützt (kann Markdown enthalten).

• Typ: string
• Erforderlich: Nein

backgroundImage

Gibt das Hintergrundbild der Karte an.

• Typ: BackgroundImage, uri
• Version: 1.2, 1.0
• Erforderlich: Nein
• Zulässige Werte:
  • BackgroundImage
  • uri

metadata

Definiert verschiedene Metadateneigenschaften, die in der Regel nicht zum Rendern der Karte verwendet werden.

• Typ: Metadata
• Version: 1.6
• Erforderlich: Nein
• Zulässige Werte:
  • Metadata

minimale Höhe

Gibt die Mindesthöhe der Karte an.

• Typ: string
• Version: 1.2
• Erforderlich: Nein

minHeight-Beispiel (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

Wenn true Inhalte in dieser adaptiven Karte von rechts nach links angezeigt werden sollen. Wenn der Inhalt als „falsch“ gekennzeichnet ist, sollte er in dieser adaptiven Karte von links nach rechts angezeigt werden. Wenn dies nicht festgelegt ist, wird das Standardverhalten der Plattform angewendet.

• Typ: boolean?
• Version: 1.5
• Erforderlich: Nein

rtl-Beispiel (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
    }
  ]
}

speak

Gibt an, was für diese gesamte Karte gesprochen werden soll. Dies ist ein einfaches Text- oder SSML-Fragment.

• Typ: string
• Erforderlich: Nein

lang

Die in der Karte verwendete 2-Buchstaben-ISO-639-1-Sprache. Wird verwendet, um alle Datums-/Uhrzeitfunktionen zu lokalisieren.

• Typ: string
• Erforderlich: Nein

vertikale Inhaltsausrichtung

Definiert, wie der Inhalt vertikal innerhalb des Containers ausgerichtet werden soll. Nur relevant für Karten mit fester Höhe oder Karten, bei denen ein minHeight angegeben ist.

• Typ: VerticalContentAlignment
• Version: 1.1
• Erforderlich: Nein
• Zulässige Werte:
  • "top"
  • "center"
  • "bottom"

$schema

Das Schema für adaptive Karten.

• Typ: uri
• Erforderlich: Nein