Document apiReferenceSelection

selection.releaseSnapshot

Release a retained exact-selection snapshot without changing document content or Undo history. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

read-onlyidempotent
doc.selection.releaseSnapshot(…)

Expected result

Returns released=true when a same-session handle was removed; otherwise false.

Inputs

snapshotIdstringrequired

Result

Output fields
releasedbooleanrequired

Failures

Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas