ProposedChange

What the covered content becomes, represented as a range inside the processed data. The range covers existing elements which were modified or new elements.

In other words, the document change says that beforeRange content becomes afterRange content.

Note, that the range is placed inside the processed data represented as a model document fragment, not in the actual model document. One processed data model fragment is shared between all document changes in a given set.

Collapsed for a change that only removes content.

Which AI feature produced the change or not set if the change did not come from AI.

See aiSource.

What the change covers, represented as a range inside the captured snapshot. The range covers the existing elements which were either removed or modified.

Note, that the range is placed inside the snapshot represented as a model document fragment, not in the actual model document. One snapshot model fragment is shared between all document changes in a given set.

Collapsed for a change that only adds content.

The ID of the document the change was captured from.

If set, holds a reason why the proposed change yields nothing (no preview to show, and nothing an apply would do).

The change's position in the set.

Assigned when the set of changes is built, does not change later on.

If true, the change relates to content that is current in read-only mode and thus the change cannot be applied.

If set, holds a reason why the proposed change cannot be applied to the current state of the document.

If not set, the change is not outdated and can be applied to the document.

The name of the editor root the change applies to.

The editing session ID during which the change was captured.

Holds information whether the user has interacted with the proposed document change.

The document version for which the change is proposed.