CollaborationOperation
Extends the operation.
Properties
-
_authorId : null | string | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_authorId -
_isDisconnection : boolean | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_isDisconnection -
_isInit : boolean | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_isInit -
affectedSelectable : ModelSelectablereadonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#affectedSelectableA selectable that will be affected by the operation after it is executed.
The exact returned parameter differs between operation types.
-
affectsData : Record<string, any> | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#affectsData -
baseVersion : null | numberinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#baseVersionversionon 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. -
module:collaboration-core/collaborationoperation~CollaborationOperation#batchBatch to which the operation is added or
nullif 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 | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#createdAt -
isDocumentOperation : booleanreadonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#isDocumentOperationDefines whether operation is executed on attached or detached items.
-
type : stringreadonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#typeOperation type.
-
wasUndone : boolean | undefinedmodule:collaboration-core/collaborationoperation~CollaborationOperation#wasUndone
Methods
-
module:collaboration-core/collaborationoperation~CollaborationOperation#cloneCreates and returns an operation that has the same parameters as this operation.
Returns
CollaborationOperationClone of this operation.
-
getReversed() → Operationinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#getReversedCreates 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
OperationReversed operation.
-
toJSON() → unknowninheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#toJSONCustom toJSON method to solve child-parent circular dependencies.
Returns
unknownClone of this object with the operation property replaced with string.
-
_execute() → voidinternalinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_executeExecutes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
_validate() → voidinternalinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_validateChecks whether the operation's parameters are correct and the operation can be correctly executed. Throws an error if operation is not valid.
Returns
void