SequenceDeltaEvent Class
Packages > fluid-framework > SequenceDeltaEvent
The event object returned on sequenceDelta events.
The properties of this object and its sub-objects represent the state of the sequence at the point in time at which the operation was applied. They will not take into consideration any future modifications performed to the underlying sequence and merge tree.
For group ops, each op will get its own event, and the group op property will be set on the op args.
Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
This API is provided for existing users, but is not recommended for new users.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here .
Signature
export declare class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType>
Extends: SequenceEvent <MergeTreeDeltaOperationType >
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(opArgs, deltaArgs, mergeTreeClient) | Deprecated, Alpha |
Constructs a new instance of the SequenceDeltaEvent class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| isLocal | Alpha |
readonly |
boolean | Whether the event was caused by a locally-made change. |
| opArgs | Alpha |
readonly |
IMergeTreeDeltaOpArgs |
Constructor Details
(constructor)
Constructs a new instance of the SequenceDeltaEvent class
This API is deprecated and will be removed in a future release.
This functionality was not meant to be exported and will be removed in a future release
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
constructor(opArgs: IMergeTreeDeltaOpArgs, deltaArgs: IMergeTreeDeltaCallbackArgs, mergeTreeClient: Client);
Parameters
| Parameter | Type | Description |
|---|---|---|
| opArgs | IMergeTreeDeltaOpArgs | |
| deltaArgs | IMergeTreeDeltaCallbackArgs | |
| mergeTreeClient | Client |
Property Details
isLocal
Whether the event was caused by a locally-made change.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
readonly isLocal: boolean;
Type: boolean
opArgs
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here .
Signature
readonly opArgs: IMergeTreeDeltaOpArgs;
Type: IMergeTreeDeltaOpArgs