ReplayFileDeltaConnection Class

Signature

export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection, IDisposable

Extends: TypedEventEmitter<IDocumentDeltaConnectionEvents

Implements: IDocumentDeltaConnection, IDisposable

Constructors

Constructor	Description
(constructor)(details, documentDeltaStorageService)	Constructs a new instance of the ReplayFileDeltaConnection class

Static Methods

Method	Return Type	Description
create(documentDeltaStorageService)	Promise<ReplayFileDeltaConnection>	Mimic the delta connection to replay ops on it.

Properties

Property	Type	Description
claims	ITokenClaims
clientId	string
details	IConnected
disposed	boolean
existing	boolean
initialClients	ISignalClient[]
initialMessages	ISequencedDocumentMessage[]
initialSignals	ISignalMessage[]
maxMessageSize	number
mode	ConnectionMode
serviceConfiguration	IClientConfiguration
version	string

Methods

Method	Return Type	Description
dispose()	void
getReplayer()	Replayer
submit(documentMessages)	void
submitSignal(message)	Promise<void>

Constructor Details

(constructor)

Constructs a new instance of the ReplayFileDeltaConnection class

Signature

constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);

Parameters

Parameter	Type	Description
details	IConnected
documentDeltaStorageService	FileDeltaStorageService

Property Details

claims

Signature

get claims(): ITokenClaims;

Type: ITokenClaims

clientId

Signature

get clientId(): string;

Type: string

details

Signature

details: IConnected;

Type: IConnected

disposed

Signature

get disposed(): boolean;

Type: boolean

existing

Signature

get existing(): boolean;

Type: boolean

initialClients

Signature

get initialClients(): ISignalClient[];

Type: ISignalClient[]

initialMessages

Signature

get initialMessages(): ISequencedDocumentMessage[];

Type: ISequencedDocumentMessage[]

initialSignals

Signature

get initialSignals(): ISignalMessage[];

Type: ISignalMessage[]

maxMessageSize

Signature

readonly maxMessageSize: number;

Type: number

mode

Signature

get mode(): ConnectionMode;

Type: ConnectionMode

serviceConfiguration

Signature

get serviceConfiguration(): IClientConfiguration;

Type: IClientConfiguration

version

Signature

get version(): string;

Type: string

Method Details

create

Mimic the delta connection to replay ops on it.

Signature

static create(documentDeltaStorageService: FileDeltaStorageService): Promise<ReplayFileDeltaConnection>;

Parameters

Parameter	Type	Description
documentDeltaStorageService	FileDeltaStorageService	The delta storage service to get ops from.

Returns

Document delta connection.

Return type: Promise<ReplayFileDeltaConnection>

dispose

Signature

dispose(): void;

getReplayer

Signature

getReplayer(): Replayer;

Returns

Return type: Replayer

submit

Signature

submit(documentMessages: IDocumentMessage[]): void;

Parameters

Parameter	Type	Description
documentMessages	IDocumentMessage[]

submitSignal

Signature

submitSignal(message: any): Promise<void>;

Parameters

Parameter	Type	Description
message	any

Returns

Return type: Promise<void>