IContainerRuntimeBaseEvents Interface

Packages > @fluidframework/runtime-definitions > IContainerRuntimeBaseEvents

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 .

Signature 

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

Extends: IEvent

Call Signatures

CallSignature Alerts Description
(event: "batchBegin", listener: (op: Omit<ISequencedDocumentMessage, "contents"> & { contents: unknown; }) => void): any Alpha
(event: "batchEnd", listener: (error: any, op: Omit<ISequencedDocumentMessage, "contents"> & { contents: unknown; }) => void): any Alpha
(event: "op", listener: (op: ISequencedDocumentMessage, runtimeMessage?: boolean) => void): any Alpha
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any Alpha
(event: "dispose", listener: () => void): any Alpha

Call Signature Details

(event: “batchBegin”, listener: (op: Omit<ISequencedDocumentMessage, “contents”> & { contents: unknown; }) => void): any

This API is provided as an alpha preview and may change without notice.

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

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

Signature 

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

(event: “batchEnd”, listener: (error: any, op: Omit<ISequencedDocumentMessage, “contents”> & { contents: unknown; }) => void): any

This API is provided as an alpha preview and may change without notice.

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

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

Signature 

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

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

This API is provided as an alpha preview and may change without notice.

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

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 as an alpha preview and may change without notice.

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

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 as an alpha preview and may change without notice.

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

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

Signature 

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