Skip to main content
Version: v1

ReplayDocumentServiceFactory Class

Signature

export declare class ReplayDocumentServiceFactory implements IDocumentServiceFactory

Implements: IDocumentServiceFactory

Constructors

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

Static Methods

Method Return Type Description
create(from, to, documentServiceFactory) ReplayDocumentServiceFactory

Properties

Property Type Description
protocolName any

Methods

Method Return Type Description
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

Parameter Type Description
documentServiceFactory IDocumentServiceFactory
controller ReplayController

Property Details

protocolName

Signature
readonly protocolName: any;

Type: any

Method Details

create

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

Parameters

Parameter Type Description
from number
to number
documentServiceFactory IDocumentServiceFactory

Returns

Return type: ReplayDocumentServiceFactory

createContainer

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

Parameters

Parameter Modifiers Type Description
createNewSummary ISummaryTree
resolvedUrl IResolvedUrl
logger optional ITelemetryBaseLogger
clientIsSummarizer optional boolean

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

Parameter Modifiers Type Description
resolvedUrl IResolvedUrl URL to be used for connecting to endpoints.
logger optional ITelemetryBaseLogger
clientIsSummarizer optional boolean

Returns

returns the requested document service

Return type: Promise<IDocumentService>