SessionLeaveCompletedParams

Params of the protected, non-view leave terminal notification.

Fields and variants

• commandId
• outcome
• reason
• sessionId
• viewCursor

Source

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

{
  "description": "Params of the protected, non-view leave terminal notification.",
  "properties": {
    "commandId": {
      "description": "The leave command's id, matching the `session/leave` request.",
      "type": "string"
    },
    "outcome": {
      "$ref": "#/$defs/SessionLeaveOutcome",
      "description": "How the leave ended: `released` or `failed`. The set is open, so newer\nhosts may add outcomes."
    },
    "reason": {
      "$ref": "#/$defs/SessionLeaveFailureReason",
      "description": "Why the leave failed. Present when `outcome` is `failed`."
    },
    "sessionId": {
      "description": "The session the leave was for.",
      "type": "string"
    },
    "viewCursor": {
      "description": "The session's view cursor at release: everything up to it was folded\nbefore the host let go. Present when `outcome` is `released`.",
      "type": "string"
    }
  },
  "required": [
    "commandId",
    "outcome",
    "sessionId"
  ],
  "type": "object"
}