UserInputAnswer

One question’s answer, as sent in userInput/answer or userInput/interrupt and as recorded in userInput/settled.

Fields and variants

• freeText
• note
• questionId
• selectedLabel
• selectedLabels

Source

schema/msp/experimental/msp.schema.json#/types/UserInputAnswer

{
  "description": "One question's answer, as sent in `userInput/answer` or\n`userInput/interrupt` and as recorded in `userInput/settled`.",
  "properties": {
    "freeText": {
      "description": "A free-form answer, at most 500 characters.",
      "type": "string"
    },
    "note": {
      "description": "An optional comment the user adds to the answer, at most 500 characters.",
      "type": "string"
    },
    "questionId": {
      "description": "The `id` of the question this answers.",
      "type": "string"
    },
    "selectedLabel": {
      "description": "The label of the chosen option, for a `single` question.",
      "type": "string"
    },
    "selectedLabels": {
      "description": "The labels of the chosen options for a `multiple` question, within its\nselection bounds; omitted when empty.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "questionId"
  ],
  "type": "object"
}