Skip to content
Document Authoring DA  API Docs v1.20.0
npmGitHub

TransactionOptions>= v1.14.0

TransactionOptions:

{
review?: { author: string };
}

Options for document transactions.

optional review: object

Tracks supported mutations as document revisions authored by this name.

Mutations that the SDK can represent as tracked changes are authored as revisions by this name. Mutations without tracked-change markup support still apply directly without revisions.

The review author is also the effective identity used by Programmatic.Revision.withdraw during this transaction. When a transaction does not specify review, withdrawal permission uses the document author callback instead, and ordinary mutations remain untracked.

A participant with the reviewer role must provide review with an author matching the participant for every transaction that commits model changes, including comment changes. Transactions without a match are rejected before the callback runs.

author: string