Skip to main content
Version: v1

ReplayDocumentServiceFactory Class

Signature

export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory

Implements: IDocumentServiceFactory

Constructors

ConstructorDescription
(constructor)(documentServiceFactory, controller)Constructs a new instance of the ReplayDocumentServiceFactory class

Static Methods

MethodReturn TypeDescription
create(from, to, documentServiceFactory)ReplayDocumentServiceFactory

Properties

PropertyTypeDescription
protocolNameany

Methods

MethodReturn TypeDescription
createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer)Promise<IDocumentService>
createDocumentService(resolvedUrl, logger, clientIsSummarizer)Promise<IDocumentService>Creates a replay document service which uses the document service of provided documentServiceFactory for connecting to delta stream endpoint.

Constructor Details

(constructor)

Constructs a new instance of the ReplayDocumentServiceFactory class

Signature

constructor(documentServiceFactory: IDocumentServiceFactory, controller: ReplayController);

Parameters

ParameterTypeDescription
documentServiceFactoryIDocumentServiceFactory
controllerReplayController

Property Details

protocolName

Signature

readonly protocolName: any;

Type: any

Method Details

create

Signature

static create(from: number, to: number, documentServiceFactory: IDocumentServiceFactory): ReplayDocumentServiceFactory;

Parameters

ParameterTypeDescription
fromnumber
tonumber
documentServiceFactoryIDocumentServiceFactory

Returns

Return type: ReplayDocumentServiceFactory

createContainer

Signature

createContainer(createNewSummary: ISummaryTree, resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters

ParameterModifiersTypeDescription
createNewSummaryISummaryTree
resolvedUrlIResolvedUrl
loggeroptionalITelemetryBaseLogger
clientIsSummarizeroptionalboolean

Returns

Return type: Promise<IDocumentService>

createDocumentService

Creates a replay document service which uses the document service of provided documentServiceFactory for connecting to delta stream endpoint.

Signature

createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters

ParameterModifiersTypeDescription
resolvedUrlIResolvedUrlURL to be used for connecting to endpoints.
loggeroptionalITelemetryBaseLogger
clientIsSummarizeroptionalboolean

Returns

returns the requested document service

Return type: Promise<IDocumentService>