CollaborationOperation
Extends the operation.
Properties
-
_authorId : null | string | undefined
module:collaboration-core/collaborationoperation~CollaborationOperation#_authorId
-
_isDisconnection : boolean | undefined
module:collaboration-core/collaborationoperation~CollaborationOperation#_isDisconnection
-
_isInit : boolean | undefined
module:collaboration-core/collaborationoperation~CollaborationOperation#_isInit
-
affectedSelectable : ModelSelectable
readonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#affectedSelectable
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
module:collaboration-core/collaborationoperation~CollaborationOperation#affectsData
-
baseVersion : null | number
inheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#baseVersion
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. -
module:collaboration-core/collaborationoperation~CollaborationOperation#batch
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
module:collaboration-core/collaborationoperation~CollaborationOperation#createdAt
-
isDocumentOperation : boolean
readonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#isDocumentOperation
Defines whether operation is executed on attached or detached items.
-
type : string
readonlyinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#type
Operation type.
-
wasUndone : boolean | undefined
module:collaboration-core/collaborationoperation~CollaborationOperation#wasUndone
Methods
-
module:collaboration-core/collaborationoperation~CollaborationOperation#clone
Creates and returns an operation that has the same parameters as this operation.
Returns
CollaborationOperation
Clone of this operation.
-
getReversed() → Operation
inheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#getReversed
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.
-
toJSON() → unknown
inheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#toJSON
Custom toJSON method to solve child-parent circular dependencies.
Returns
unknown
Clone of this object with the operation property replaced with string.
-
_execute() → void
internalinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_execute
Executes the operation - modifications described by the operation properties will be applied to the model tree.
Returns
void
-
_validate() → void
internalinheritedmodule:collaboration-core/collaborationoperation~CollaborationOperation#_validate
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