ReplayFileDeltaConnection Class

Packages > @fluidframework/file-driver > ReplayFileDeltaConnection

Signature:

export declare class ReplayFileDeltaConnection extends TypedEventEmitter<IDocumentDeltaConnectionEvents> implements IDocumentDeltaConnection 

Extends: TypedEventEmitter<IDocumentDeltaConnectionEvents>

Implements: IDocumentDeltaConnection

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(details, documentDeltaStorageService) Constructs a new instance of the ReplayFileDeltaConnection class

Properties

List of properties for this class
Property Modifiers Type Description
claims ITokenClaims
clientId string
details IConnected
existing boolean
initialClients ISignalClient[]
initialMessages ISequencedDocumentMessage[]
initialSignals ISignalMessage[]
maxMessageSize number
mode ConnectionMode
serviceConfiguration IClientConfiguration
version string

Methods

List of methods on this class
Method Modifiers Description
close()
create(documentDeltaStorageService) static Mimic the delta connection to replay ops on it.
getReplayer()
submit(documentMessages)
submitSignal(message)

Constructors

ReplayFileDeltaConnection.(constructor)

Constructs a new instance of the ReplayFileDeltaConnection class

Signature:

constructor(details: IConnected, documentDeltaStorageService: FileDeltaStorageService);

Parameters

List of parameters
Parameter Type Description
details IConnected
documentDeltaStorageService FileDeltaStorageService

Properties

claims

Signature:

get claims(): ITokenClaims;

clientId

Signature:

get clientId(): string;

details

Signature:

details: IConnected;

existing

Signature:

get existing(): boolean;

initialClients

Signature:

get initialClients(): ISignalClient[];

initialMessages

Signature:

get initialMessages(): ISequencedDocumentMessage[];

initialSignals

Signature:

get initialSignals(): ISignalMessage[];

maxMessageSize

Signature:

readonly maxMessageSize: number;

mode

Signature:

get mode(): ConnectionMode;

serviceConfiguration

Signature:

get serviceConfiguration(): IClientConfiguration;

version

Signature:

get version(): string;

Methods

close

Signature:

close(): void;

Returns:

void

create

Mimic the delta connection to replay ops on it.

Signature:

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

Parameters

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

Returns:

Promise<ReplayFileDeltaConnection>

Document delta connection.

getReplayer

Signature:

getReplayer(): Replayer;

Returns:

Replayer

submit

Signature:

submit(documentMessages: IDocumentMessage[]): void;

Parameters

List of parameters
Parameter Type Description
documentMessages IDocumentMessage[]

Returns:

void

submitSignal

Signature:

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

Parameters

List of parameters
Parameter Type Description
message any

Returns:

Promise<void>