Document apiReferenceHistory

history.redo

Redo the most recently undone action in the document.

mutates documentnon-idempotent
doc.history.redo(…)

Expected result

Returns a HistoryActionResult with noop flag, revision before/after, optional noop reason, and optional ref-effect fields such as inserted, removed, invalidatedRefs, remappedRefs, and affectedStories.

Inputs

This operation takes no input fields.

Result

Output fields
noopbooleanrequired
reason"EMPTY_UNDO_STACK" | "EMPTY_REDO_STACK" | "NO_EFFECT" | "no-undo-available" | "no-redo-available" | "history-entry-missing" | "apply-rejected"
revisionobjectrequired
Fields
beforestringrequired
afterstringrequired
insertedEntityAddress[]
updatedEntityAddress[]
removedEntityAddress[]
invalidatedRefsAffectedRef[]
remappedRefsAffectedRefRemapping[]
affectedStoriesStoryLocator[]
textRangeShiftsTextRangeShift[]
status"applied" | "noop" | "rejected" | "partial" | "repaired"
diagnosticCodestring
collaborationobject
Fields
mode"session-local" | "single-shard" | "journaled-multi-shard"required
undoGroupIdstring
opIdstring
affectedShardsstring[]

Failures

Pre-apply throws

  • CAPABILITY_UNAVAILABLE

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