Sign up (with export icon)

DocumentChange

Api-interface iconinterface

Represents a single change document change.

Properties

  • Chevron-right icon

    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.

  • Chevron-right icon

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

    See aiSource.

  • Chevron-right icon

    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.

  • Chevron-right icon

    channelId: string

    The ID of the document the change was captured from.

  • Chevron-right icon

    rootName: string

    The name of the editor root the change applies to.

  • Chevron-right icon

    sessionId: string

    The editing session ID during which the change was captured.

  • Chevron-right icon

    version: number

    The document version for which the change is proposed.