TurnStartResult

turn/start result.

Fields and variants

• commandId
• disposition
• startedNewTurn
• status
• turnId

Source

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

{
  "description": "`turn/start` result.",
  "properties": {
    "commandId": {
      "description": "Echoes the client's id.",
      "type": "string"
    },
    "disposition": {
      "$ref": "#/$defs/TurnStartDisposition",
      "description": "What happened to the input."
    },
    "startedNewTurn": {
      "description": "`true` iff `disposition` is `started`; retained as the boolean\nshorthand — `disposition` is authoritative.",
      "type": "boolean"
    },
    "status": {
      "$ref": "#/$defs/CommandStatus",
      "description": "Admission status."
    },
    "turnId": {
      "description": "The turn that will carry (or absorbed) this input. Authoritative:\nalways take it from the ack rather than deriving it.",
      "type": "string"
    }
  },
  "required": [
    "commandId",
    "disposition",
    "startedNewTurn",
    "status",
    "turnId"
  ],
  "type": "object"
}