IMergeTreeDeltaOpArgs Interface
Packages > @fluidframework/merge-tree > IMergeTreeDeltaOpArgs
This API is provided for existing users, but is not recommended for new users.
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 | Alpha |
optional , readonly |
IMergeTreeGroupMsg | The group op which contains the operation if there operation is part of a group op. |
op | Alpha |
readonly |
IMergeTreeOp | The IMergeTreeOp corresponding to the delta. |
sequencedMessage | Alpha |
optional , readonly |
ISequencedDocumentMessage |
The 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.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly groupOp?: IMergeTreeGroupMsg;
Type: IMergeTreeGroupMsg
op
The IMergeTreeOp corresponding to the delta.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha
.
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 ).
sequencedMessage
The ISequencedDocumentMessage corresponding to this acknowledged change.
This field is omitted for deltas corresponding to unacknowledged changes.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/merge-tree/alpha
.
For more information about our API support guarantees, see here .
Signature
readonly sequencedMessage?: ISequencedDocumentMessage;