Input.Signature

Cardscript

Lets a user enter a signature.

Example

{
  "type": "AdaptiveCard",
  "body": [
    {
      "id": "inputSignature",
      "type": "Input.Signature",
      "agreement": "I agree that...",
      "saveText": "Send",
      "guidance": "Please enter your signature below..."
    }
  ],
  "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
  "version": "1.0"
}

Required properties

id

Unique identifier for the value. Used to identify collected input when the Submit action is performed.

• Type: string

---

type

Must be "Input.Signature".

• Type: string
• Values:
  • Input.Signature

Optional properties

agreement

Agreement text to be displayed above the signature pad.

• Type: string

---

saveText

Customise the text of the save button.

• Type: string

---

guidance

Guidance text to be displayed with the signature button.

• 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": "Input.Signature",
  "description": "Lets a user enter a signature.",
  "allOf": [
    {
      "$ref": "#/definitions/CardElement"
    }
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the value. Used to identify collected input when the Submit action is performed."
    },
    "type": {
      "type": "string",
      "description": "Must be `\"Input.Signature\"`.",
      "enum": [
        "Input.Signature"
      ]
    },
    "agreement": {
      "type": "string",
      "description": "Agreement text to be displayed above the signature pad."
    },
    "saveText": {
      "type": "string",
      "description": "Customise the text of the save button."
    },
    "guidance": {
      "type": "string",
      "description": "Guidance text to be displayed with the signature button."
    }
  },
  "required": [
    "type",
    "id"
  ],
  "typeSafe": "input-signature",
  "example": "FIXME!",
  "propertySummary": [
    {
      "name": "id",
      "type": "string",
      "required": "Required",
      "text": "Unique identifier for the value. Used to identify collected input when the Submit action is performed."
    },
    {
      "name": "type",
      "type": "string",
      "required": "Required",
      "text": "Must be `\"Input.Signature\"`."
    },
    {
      "name": "agreement",
      "type": "string",
      "required": "Optional",
      "text": "Agreement text to be displayed above the signature pad."
    },
    {
      "name": "saveText",
      "type": "string",
      "required": "Optional",
      "text": "Customise the text of the save button."
    },
    {
      "name": "guidance",
      "type": "string",
      "required": "Optional",
      "text": "Guidance text to be displayed with the signature button."
    }
  ]
}