ViewSnapshot

The snapshot object returned by session/resume / session/read.

Fields and variants

• anchor
• schemaVersion
• state
• viewCursor

Source

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

{
  "description": "The `snapshot` object returned by `session/resume` / `session/read`.",
  "properties": {
    "anchor": {
      "$ref": "#/$defs/SnapshotAnchor",
      "description": "Present exactly when `history.mode` is `anchoredSnapshot`."
    },
    "schemaVersion": {
      "description": "Snapshot schema version. A client whose generated types are older than\nthis must fall back to inline/paged history.",
      "type": "integer"
    },
    "state": {
      "$ref": "#/$defs/SnapshotState",
      "description": "The complete folded view at `viewCursor`."
    },
    "viewCursor": {
      "description": "The cursor the state is folded at; every event after it streams as the\nsuffix.",
      "type": "string"
    }
  },
  "required": [
    "schemaVersion",
    "state",
    "viewCursor"
  ],
  "type": "object"
}