Skip to main content
Version: v1

IDeltaManagerEvents Interface

Events emitted by the Delta Manager

Signature

export interface IDeltaManagerEvents extends IEvent

Extends: IEvent

Call Signatures

CallSignature Description
(event: "prepareSend", listener: (messageBuffer: any[]) => void): any
(event: "submitOp", listener: (message: IDocumentMessage) => void): any
(event: "op", listener: (message: ISequencedDocumentMessage, processingTime: number) => void): any
(event: "allSentOpsAckd", listener: () => void): any
(event: "pong" | "processTime", listener: (latency: number) => void): any
(event: "connect", listener: (details: IConnectionDetails, opsBehind?: number) => void): any The connect event fires once we've received the connect_document_success message from the server. This happens prior to the client's join message (if there is a join message).
(event: "disconnect", listener: (reason: string) => void): any
(event: "readonly", listener: (readonly: boolean) => void): any

Call Signature Details

(event: "prepareSend", listener: (messageBuffer: any[]) => void): any

Signature

(event: "prepareSend", listener: (messageBuffer: any[]) => void): any;

(event: "submitOp", listener: (message: IDocumentMessage) => void): any

Signature

(event: "submitOp", listener: (message: IDocumentMessage) => void): any;

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

Signature

(event: "op", listener: (message: ISequencedDocumentMessage, processingTime: number) => void): any;

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

Signature

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

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

Signature

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

(event: "connect", listener: (details: IConnectionDetails, opsBehind?: number) => void): any

The connect event fires once we've received the connect_document_success message from the server. This happens prior to the client's join message (if there is a join message).

Signature

(event: "connect", listener: (details: IConnectionDetails, opsBehind?: number) => void): any;

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

Signature

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

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

Signature

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