UserInputCancelResult

userInput/cancel result.

Fields and variants

• commandId
• status
• userInputId

Source

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

{
  "description": "`userInput/cancel` result.",
  "properties": {
    "commandId": {
      "description": "Echoes the client's id.",
      "type": "string"
    },
    "status": {
      "$ref": "#/$defs/CommandStatus",
      "description": "Admission status."
    },
    "userInputId": {
      "description": "The prompt this cancellation settled.",
      "type": "string"
    }
  },
  "required": [
    "commandId",
    "status",
    "userInputId"
  ],
  "type": "object"
}