ISharedSegmentSequenceEvents Interface

Packages > fluid-framework > ISharedSegmentSequenceEvents

Events emitted in response to changes to the sequence data.

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 interface ISharedSegmentSequenceEvents extends ISharedObjectEvents

Extends: ISharedObjectEvents

Remarks

The following is the list of events emitted.

### “sequenceDelta”

The sequenceDelta event is emitted when segments are inserted, annotated, or removed.

#### Listener signature

(event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void

  • event - Various information on the segments that were modified.

  • target - The sequence itself.

### “maintenance”

The maintenance event is emitted when segments are modified during merge-tree maintenance.

#### Listener signature

(event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void

  • event - Various information on the segments that were modified.

  • target - The sequence itself.

Call Signatures

CallSignature Alerts Description
(event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): void Alpha
(event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): void Alpha
(event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): void Alpha

Call Signature Details

(event: “createIntervalCollection”, listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): void

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 

(event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): void;

(event: “sequenceDelta”, listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): void

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 

(event: "sequenceDelta", listener: (event: SequenceDeltaEvent, target: IEventThisPlaceHolder) => void): void;

(event: “maintenance”, listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): void

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 

(event: "maintenance", listener: (event: SequenceMaintenanceEvent, target: IEventThisPlaceHolder) => void): void;