Skip to main content

IFluidDataStoreRuntimeEvents Interface

Events emitted by IFluidDataStoreRuntime.

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

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

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

Signature​

export interface IFluidDataStoreRuntimeEvents extends IEvent

Extends: IEvent

Call Signatures​

CallSignature Alerts Description
(event: "disconnected", listener: () => void): any Alpha
(event: "dispose", listener: () => void): any Alpha
(event: "attaching", listener: () => void): any Alpha
(event: "attached", listener: () => void): any Alpha
(event: "op", listener: (message: ISequencedDocumentMessage) => void): any Alpha
(event: "signal", listener: (message: IInboundSignalMessage, local: boolean) => void): any Alpha
(event: "connected", listener: (clientId: string) => void): any Alpha

Call Signature Details​

(event: "disconnected", listener: () => void): any​

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

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

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

Signature​

(event: "disconnected", listener: () => 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/datastore-definitions/alpha.

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

Signature​

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

(event: "attaching", listener: () => void): any​

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

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

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

Signature​

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

(event: "attached", listener: () => void): any​

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

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

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

Signature​

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

(event: "op", listener: (message: ISequencedDocumentMessage) => void): any​

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

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

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

Signature​

(event: "op", listener: (message: ISequencedDocumentMessage) => 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/datastore-definitions/alpha.

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

Signature​

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

(event: "connected", listener: (clientId: string) => void): any​

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

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

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

Signature​

(event: "connected", listener: (clientId: string) => void): any;