IContainerRuntimeBaseEvents Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/runtime-definitions/legacy.

For more information about our API support guarantees, see here.

Sealed

This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.

Signature

/** @sealed */
export interface IContainerRuntimeBaseEvents extends IEvent

Extends: IEvent

Call Signatures

Call Signature	Alerts	Return Type	Description
(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any	Beta	any	Indicates the beginning of an incoming batch of ops
(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any	Beta	any	Indicates the end of an incoming batch of ops
(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any	Beta	any	Indicates that an incoming op has been processed.
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any	Beta	any
(event: "dispose", listener: () => void): any	Beta	any
(event: "stagingModeChanged", listener: (stagingModeInfo: StagingModeChangedEvent) => void): any	Beta	any	Fires when the container runtime enters or exits staging mode.
(event: "hasStagedChangesChanged", listener: (hasStagedChanges: boolean) => void): any	Beta	any	Emitted when hasStagedChanges changes value, i.e. when staged changes (submitted while in Staging Mode) are first introduced, or when they are all discarded or committed. Listener parameters: hasStagedChanges: The new value of hasStagedChanges.

Call Signature Details

(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any

Indicates the beginning of an incoming batch of ops

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents">) => void): any;

(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any

Indicates the end of an incoming batch of ops

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "batchEnd", listener: (error: unknown, op: Omit<ISequencedDocumentMessage, "contents">) => void): any;

(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any

Indicates that an incoming op has been processed.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any;

(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any;

(event: "dispose", listener: () => void): any

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "dispose", listener: () => void): any;

(event: "stagingModeChanged", listener: (stagingModeInfo: StagingModeChangedEvent) => void): any

Fires when the container runtime enters or exits staging mode.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "stagingModeChanged", listener: (stagingModeInfo: StagingModeChangedEvent) => void): any;

Remarks

This event is not emitted when the container is disposed while in staging mode. If the container is disposed, staged changes are silently dropped.

(event: "hasStagedChangesChanged", listener: (hasStagedChanges: boolean) => void): any

Emitted when hasStagedChanges changes value, i.e. when staged changes (submitted while in Staging Mode) are first introduced, or when they are all discarded or committed.

Listener parameters:

• hasStagedChanges: The new value of hasStagedChanges.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

(event: "hasStagedChangesChanged", listener: (hasStagedChanges: boolean) => void): any;