AddressBlock

Cardscript

Displays an address.

Example

{
  "type": "AdaptiveCard",
  "body": [
    {
      "type": "AddressBlock",
      "dataPath": "addressBlock"
    }
  ],
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "version": "1.0"
}

Required properties

type

Must be "AddressBlock".

• Type: string
• Values:
  • AddressBlock

---

dataPath

Points to the holding the address.

• Type: string

Optional properties

title

Title of the AddressBlock.

• Type: string
• Default: "Address"

---

multiline

Wether the address in multiple lines.

• Type: boolean
• Default: true

---

lineDelimited

The string of character(s) which the address is delimited by.

• Type: string
• Default: ","

---

id

A unique identifier associated with the element.

• Type: string

---

spacing

Controls the amount of spacing between this element and the preceding element.

• Type: string
• Values:
  • none
  • small
  • default
  • medium
  • large
  • extraLarge
  • padding

---

separator

When true, draw a separating line at the top of the element.

• Type: boolean

---

JSON Schema

{
  "additionalProperties": true,
  "type": "AddressBlock",
  "description": "Displays an address.",
  "version": "1.1",
  "allOf": [
    {
      "$ref": "#/definitions/CardElement"
    }
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Must be `\"AddressBlock\"`.",
      "enum": [
        "AddressBlock"
      ]
    },
    "title": {
      "type": "string",
      "description": "Title of the AddressBlock.",
      "default": "Address"
    },
    "dataPath": {
      "type": "string",
      "description": "Points to the holding the address."
    },
    "multiline": {
      "type": "boolean",
      "default": true,
      "description": "Wether the address in multiple lines."
    },
    "lineDelimited": {
      "type": "string",
      "default": ",",
      "description": "The string of character(s) which the address is delimited by."
    }
  },
  "required": [
    "type",
    "dataPath"
  ],
  "typeSafe": "address-block",
  "example": "FIXME!",
  "propertySummary": [
    {
      "name": "type",
      "type": "string",
      "required": "Required",
      "text": "Must be `\"AddressBlock\"`."
    },
    {
      "name": "title",
      "type": "string",
      "required": "Optional",
      "text": "Title of the AddressBlock."
    },
    {
      "name": "dataPath",
      "type": "string",
      "required": "Required",
      "text": "Points to the holding the address."
    },
    {
      "name": "multiline",
      "type": "boolean",
      "required": "Optional",
      "text": "Wether the address in multiple lines."
    },
    {
      "name": "lineDelimited",
      "type": "string",
      "required": "Optional",
      "text": "The string of character(s) which the address is delimited by."
    }
  ]
}