CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

CollaborationOperation (collaboration-core)

@ckeditor/ckeditor5-collaboration-core/src/collaborationoperation

interface

Extends the operation.

Filtering

Properties

  • _authorId : null | string | undefined

  • _isDisconnection : boolean | undefined

  • _isInit : boolean | undefined

  • readonly inherited

    affectedSelectable : Selectable

    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

  • inherited

    baseVersion : null | number

    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.

  • inherited

    batch : null | Batch

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

  • createdAt : Date | undefined

  • readonly inherited

    isDocumentOperation : boolean

    Defines whether operation is executed on attached or detached items.

  • readonly inherited

    type : string

    Operation type.

  • wasUndone : boolean | undefined

Methods

  • clone() → CollaborationOperation

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

    Returns

    CollaborationOperation

    Clone of this operation.

  • inherited

    getReversed() → Operation

    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.

  • inherited

    toJSON() → unknown

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    unknown

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

  • internal inherited

    _execute() → void

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

    Returns

    void

  • internal inherited

    _validate() → void

    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