Document apiReferenceHistory
history.beginGroup
Begin one editor-local undo group across awaited public writes. Nesting and temporary mutation overlap are rejected. Finish with endGroup in finally; failed writes leave the successful prefix undoable. Native input and undo/redo finish the group; remote peer edits retain their own ownership.
read-onlynon-idempotent
doc.history.beginGroup(…)Expected result
Returns a session-local groupId. Empty groups create no history entry. The handle does not survive document replacement or reopen.
Inputs
This operation takes no input fields.
Result
Output fields
groupIdstringrequiredFailures
Pre-apply throws
CAPABILITY_UNAVAILABLEPRECONDITION_FAILED
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