SequenceEvent Class

Packages > @fluidframework/sequence > SequenceEvent

Base class for SequenceDeltaEvent and SequenceMaintenanceEvent.

The properties of this object and its sub-objects represent a point in time state at the time the operation was applied. They will not take into any future modifications performed to the underlying sequence and merge tree.

Signature:

export declare abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> 

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(deltaArgs, mergeTreeClient) Constructs a new instance of the SequenceEvent class

Properties

List of properties for this class
Property Modifiers Type Description
clientId string The client id of the client that made the change which caused the delta event
deltaArgs IMergeTreeDeltaCallbackArgs
deltaOperation TOperation
first Readonly<ISequenceDeltaRange>
isEmpty boolean
last Readonly<ISequenceDeltaRange>
ranges readonly Readonly<ISequenceDeltaRange>[] The in-order ranges affected by this delta. These may not be continous.

Constructors

SequenceEvent.(constructor)

Constructs a new instance of the SequenceEvent class

Signature:

constructor(deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>, mergeTreeClient: Client);

Parameters

List of parameters
Parameter Type Description
deltaArgs IMergeTreeDeltaCallbackArgs
mergeTreeClient Client

Properties

clientId

The client id of the client that made the change which caused the delta event

Signature:

get clientId(): string;

deltaArgs

Signature:

readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>;

deltaOperation

Signature:

readonly deltaOperation: TOperation;

first

Signature:

get first(): Readonly<ISequenceDeltaRange<TOperation>>;

isEmpty

Signature:

readonly isEmpty: boolean;

last

Signature:

get last(): Readonly<ISequenceDeltaRange<TOperation>>;

ranges

The in-order ranges affected by this delta. These may not be continous.

Signature:

get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[];