IMergeTreeDeltaOpArgs Interface
To use, import via @fluidframework/merge-tree/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IMergeTreeDeltaOpArgs
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| groupOp | Beta | optional, readonly | IMergeTreeGroupMsg | The group op which contains the operation if there operation is part of a group op. |
| op | Beta | readonly | IMergeTreeOp | The IMergeTreeOp corresponding to the delta. |
| rollback | Beta | optional, readonly | true | Set to true if this delta is being performed as part of a rollback of unsent local changes. |
| sequencedMessage | Beta | optional, readonly | ISequencedDocumentMessage | The @fluidframework/protocol-definitions#ISequencedDocumentMessage corresponding to this acknowledged change. This field is omitted for deltas corresponding to unacknowledged changes. |
Property Details
groupOp
The group op which contains the operation if there operation is part of a group op.
For more information about our API support guarantees, see here.
Signature
readonly groupOp?: IMergeTreeGroupMsg;
Type: IMergeTreeGroupMsg
op
The IMergeTreeOp corresponding to the delta.
For more information about our API support guarantees, see here.
Signature
readonly op: IMergeTreeOp;
Type: IMergeTreeOp
Remarks
This is useful for determining the type of change (see MergeTreeDeltaType).
rollback
Set to true if this delta is being performed as part of a rollback of unsent local changes.
For more information about our API support guarantees, see here.
Signature
readonly rollback?: true;
Type: true
sequencedMessage
The @fluidframework/protocol-definitions#ISequencedDocumentMessage corresponding to this acknowledged change.
This field is omitted for deltas corresponding to unacknowledged changes.
For more information about our API support guarantees, see here.
Signature
readonly sequencedMessage?: ISequencedDocumentMessage;