AdaptiveCard-element

Deze pagina documenteert het AdaptiveCard element, het hoofdelement van een adaptieve kaart.

Belangrijke opmerking over toegankelijkheid: In versie 1.3 van het schema hebben we een labeleigenschap geïntroduceerd op Invoer om de toegankelijkheid te verbeteren. Als de Host-app die u als doel hebt , v1.3 ondersteunt, moet u een label gebruiken in plaats van een TextBlock , zoals in enkele voorbeelden hieronder wordt weergegeven. Zodra de meeste Host-apps zijn bijgewerkt naar de nieuwste versie, werken we de voorbeelden dienovereenkomstig bij.

AdaptiveCard

Een adaptieve kaart die een vrije vorm van kaartelementen bevat en een optionele set acties.

AdaptiveCard-eigenschappen

Example

Voorbeeld van Basic 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"
		}
	]
}

Eigenschappen

version

Schemaversie die deze kaart nodig heeft. Als een cliënt lager is dan deze versie, wordt fallbackText weergegeven. OPMERKING: Versie is niet vereist voor kaarten binnen een Action.ShowCard. Het is echter vereist voor de kaart op het hoogste niveau.

• Typ: string
• Vereist: Nee

vernieuwen

Definieert hoe de kaart kan worden vernieuwd door een aanvraag naar de doelbot te verzenden.

• Typ: Refresh
• Versie: 1.4
• Vereist: Nee
• Toegestane waarden:
  • Refresh

Voorbeeld vernieuwen (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."
		}
	]
}

authenticatie

Hiermee definieert u verificatiegegevens voor het inschakelen van eenmalige aanmelding of Just-In-Time OAuth.

• Typ: Authentication
• Versie: 1.4
• Vereist: Nee
• Toegestane waarden:
  • Authentication

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

De kaartelementen die moeten worden weergegeven in de primaire kaartregio.

• Typ: Element[]
• Vereist: Nee
• Toegestane waarden:
  • ActionSet
  • ColumnSet
  • Container
  • FactSet
  • Image
  • ImageSet
  • Input.ChoiceSet
  • Input.Date
  • Input.Number
  • Input.Text
  • Input.Time
  • Input.Toggle
  • Media
  • RichTextBlock
  • Table
  • TextBlock

Acties

De acties die moeten worden weergegeven op de actiebalk van de kaart.

• Typ: Action[]
• Vereist: Nee
• Toegestane waarden:
  • Action.Execute
  • Action.OpenUrl
  • Action.ShowCard
  • Action.Submit
  • Action.ToggleVisibility

selectAction

Een actie die wordt aangeroepen wanneer de kaart wordt getikt of geselecteerd. Action.ShowCard wordt niet ondersteund.

• Typ: ISelectAction
• Versie: 1.1
• Vereist: Nee
• Toegestane waarden:
  • Action.Execute
  • Action.OpenUrl
  • Action.Submit
  • Action.ToggleVisibility

fallbackText

Tekst die wordt weergegeven wanneer de client de opgegeven versie niet ondersteunt (kan markdown bevatten).

• Typ: string
• Vereist: Nee

achtergrondafbeelding

Hiermee geeft u de achtergrondafbeelding van de kaart.

• Type: BackgroundImage, uri
• Versie: 1.2, 1.0
• Vereist: Nee
• Toegestane waarden:
  • BackgroundImage
  • uri

metadata

Definieert verschillende metagegevenseigenschappen die doorgaans niet worden gebruikt voor het weergeven van de kaart

• Typ: Metadata
• Versie: 1.6
• Vereist: Nee
• Toegestane waarden:
  • Metadata

minHeight

Hiermee wordt de minimale hoogte van de kaart gespecificeerd.

• Typ: string
• Versie: 1.2
• Vereist: Nee

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

Wanneer true inhoud in deze adaptieve kaart van rechts naar links moet worden weergegeven. Wanneer 'onwaar' inhoud in deze adaptieve kaart links naar rechts moet worden weergegeven. Als dit niet is ingesteld, is het standaardplatformgedrag van toepassing.

• Typ: boolean?
• Versie: 1.5
• Vereist: Nee

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

spreken

Hiermee specificeert u wat er gezegd moet worden voor de gehele kaart. Dit is eenvoudige tekst of SSML-fragment.

• Typ: string
• Vereist: Nee

lang

De ISO-639-1-taal van 2 letters die in de kaart wordt gebruikt. Wordt gebruikt om datum-/tijdfuncties te lokaliseren.

• Typ: string
• Vereist: Nee

verticaleInhoudUitlijning

Hiermee definieert u hoe de inhoud verticaal in de container moet worden uitgelijnd. Alleen relevant voor kaarten met vaste hoogte of kaarten met een minHeight opgegeven waarde.

• Typ: VerticalContentAlignment
• Versie: 1.1
• Vereist: Nee
• Toegestane waarden:
  • "top"
  • "center"
  • "bottom"

$schema

Het adaptieve kaartschema.

• Typ: uri
• Vereist: Nee