SequenceEvent Class
Packages > fluid-framework > SequenceEvent
Base class for SequenceDeltaEvent and SequenceMaintenanceEvent.
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 any future modifications performed to the underlying sequence and merge tree.
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 abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes>
Type Parameters
Parameter | Constraint | Default | Description |
---|---|---|---|
TOperation | MergeTreeDeltaOperationTypes | MergeTreeDeltaOperationTypes |
Constructors
Constructor | Alerts | Description |
---|---|---|
(constructor)(deltaArgs, mergeTreeClient) |
Alpha
|
Constructs a new instance of the SequenceEvent class
|
Properties
Property | Alerts | Modifiers | Type | Description |
---|---|---|---|---|
clientId |
Alpha
|
readonly
|
string | undefined | The client id of the client that made the change which caused the delta event |
deltaArgs |
Alpha
|
readonly
|
IMergeTreeDeltaCallbackArgs<TOperation> | Arguments reflecting the type of change that caused this event. |
deltaOperation |
Alpha
|
readonly
|
TOperation | |
first |
Alpha
|
readonly
|
Readonly<ISequenceDeltaRange<TOperation>> | The first of the modified ranges. |
last |
Alpha
|
readonly
|
Readonly<ISequenceDeltaRange<TOperation>> | The last of the modified ranges. |
ranges |
Alpha
|
readonly
|
readonly Readonly<ISequenceDeltaRange<TOperation>>[] | The in-order ranges affected by this delta. These are not necessarily contiguous. |
Constructor Details
(constructor)
Constructs a new instance of the SequenceEvent
class
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(
deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>, mergeTreeClient: Client);
Parameters
Parameter | Type | Description |
---|---|---|
deltaArgs | IMergeTreeDeltaCallbackArgs<TOperation> | |
mergeTreeClient | Client |
Property Details
clientId
The client id of the client that made the change which caused the delta event
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
get clientId(): string | undefined;
Type: string | undefined
deltaArgs
Arguments reflecting the type of change that caused this event.
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 deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>;
Type: IMergeTreeDeltaCallbackArgs <TOperation>
deltaOperation
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 deltaOperation: TOperation;
Type: TOperation
first
The first of the modified ranges.
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
get first(): Readonly<ISequenceDeltaRange<TOperation>>;
Type: Readonly<ISequenceDeltaRange <TOperation>>
last
The last of the modified ranges.
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
get last(): Readonly<ISequenceDeltaRange<TOperation>>;
Type: Readonly<ISequenceDeltaRange <TOperation>>
ranges
The in-order ranges affected by this delta. These are not necessarily contiguous.
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
get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[];
Type: readonly Readonly<ISequenceDeltaRange <TOperation>>[]
Remarks
- If processing code doesn’t care about the order of the ranges, it may instead consider using the deltaSegments field on deltaArgs .