Skip to main content

IDocumentDeltaConnectionEvents Interface

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

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

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

Signature​

export interface IDocumentDeltaConnectionEvents extends IErrorEvent

Extends: IErrorEvent

Call Signatures​

CallSignature Alerts Description
(event: "nack", listener: (documentId: string, message: INack[]) => void): any Alpha
(event: "disconnect", listener: (reason: IAnyDriverError) => void): any Alpha
(event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any Alpha
(event: "signal", listener: (message: ISignalMessage | ISignalMessage[]) => void): any Alpha
(event: "pong", listener: (latency: number) => void): any Alpha
(event: "error", listener: (error: any) => void): any Alpha

Call Signature Details​

(event: "nack", listener: (documentId: string, message: INack[]) => void): any​

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

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

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

Signature​

(event: "nack", listener: (documentId: string, message: INack[]) => void): any;

(event: "disconnect", listener: (reason: IAnyDriverError) => void): any​

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

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

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

Signature​

(event: "disconnect", listener: (reason: IAnyDriverError) => void): any;

(event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any​

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

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

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

Signature​

(event: "op", listener: (documentId: string, messages: ISequencedDocumentMessage[]) => void): any;

(event: "signal", listener: (message: ISignalMessage | ISignalMessage[]) => void): any​

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

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

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

Signature​

(event: "signal", listener: (message: ISignalMessage | ISignalMessage[]) => void): any;

(event: "pong", listener: (latency: number) => void): any​

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

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

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

Signature​

(event: "pong", listener: (latency: number) => void): any;

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

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

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

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

Signature​

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