SessionHistory

The history envelope shared by session/resume, session/fork, and session/read.

Fields and variants

• items
• mode
• noneReason
• snapshot

Source

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

{
  "description": "The `history` envelope shared by `session/resume`, `session/fork`, and\n`session/read`.",
  "properties": {
    "items": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/$defs/Item"
          },
          "type": "array"
        },
        {
          "type": "null"
        }
      ],
      "description": "The full folded item array when `mode` is `inline`; `null` otherwise."
    },
    "mode": {
      "$ref": "#/$defs/HistoryMode",
      "description": "What was actually served — never what was asked for."
    },
    "noneReason": {
      "$ref": "#/$defs/HistoryNoneReason",
      "description": "Why no history was served — sent exactly when `mode` is `\"none\"`."
    },
    "snapshot": {
      "anyOf": [
        {
          "$ref": "#/$defs/ViewSnapshot"
        },
        {
          "type": "null"
        }
      ],
      "description": "The folded view state when `mode` is `snapshot` or `anchoredSnapshot`;\n`null` otherwise."
    }
  },
  "required": [
    "items",
    "mode",
    "snapshot"
  ],
  "type": "object"
}