Sign up (with export icon)

CollaborationOperation

Api-interface icon interface

Extends the operation.

Properties

  • _authorId : null | string | undefined

  • _isDisconnection : boolean | undefined

  • _isInit : boolean | undefined

  • Chevron-right icon

    affectedSelectable : ModelSelectable
    readonlyinherited

    A selectable that will be affected by the operation after it is executed.

    The exact returned parameter differs between operation types.

  • affectsData : Record<string, any> | undefined

  • Chevron-right icon

    baseVersion : null | number
    inherited

    version on which operation can be applied. If you try to apply operation with different base version than the document version the model-document-applyOperation-wrong-version error is thrown.

  • Chevron-right icon

    batch : null | Batch
    inherited

    Batch to which the operation is added or null if the operation is not added to any batch yet.

    Note, that a non-document operation has this property always set to null, and is never added to any batch.

  • createdAt : Date | undefined

  • Chevron-right icon

    isDocumentOperation : boolean
    readonlyinherited

    Defines whether operation is executed on attached or detached items.

  • Chevron-right icon

    type : string
    readonlyinherited

    Operation type.

  • wasUndone : boolean | undefined

Methods

  • Chevron-right icon

    Creates and returns an operation that has the same parameters as this operation.

    Returns

    CollaborationOperation

    Clone of this operation.

  • Chevron-right icon

    getReversed() → Operation
    inherited

    Creates and returns a reverse operation. Reverse operation when executed right after the original operation will bring back tree model state to the point before the original operation execution. In other words, it reverses changes done by the original operation.

    Keep in mind that tree model state may change since executing the original operation, so reverse operation will be "outdated". In that case you will need to transform it by all operations that were executed after the original operation.

    Returns

    Operation

    Reversed operation.

  • Chevron-right icon

    toJSON() → unknown
    inherited

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

    Clone of this object with the operation property replaced with string.

  • Chevron-right icon

    _execute() → void
    internalinherited

    Executes the operation - modifications described by the operation properties will be applied to the model tree.

    Returns

    void
  • Chevron-right icon

    _validate() → void
    internalinherited

    Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.

    Returns

    void