RouterliciousDocumentServiceFactory Class

Packages > @fluidframework/routerlicious-driver > RouterliciousDocumentServiceFactory

Factory for creating the routerlicious document service. Use this if you want to use the routerlicious implementation.

Signature:

export declare class RouterliciousDocumentServiceFactory implements IDocumentServiceFactory 

Implements: IDocumentServiceFactory

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(tokenProvider, useDocumentService2, errorTracking, disableCache, historianApi, gitCache, credentials) Constructs a new instance of the RouterliciousDocumentServiceFactory class

Properties

List of properties for this class
Property Modifiers Type Description
protocolName (not declared)

Methods

List of methods on this class
Method Modifiers Description
createContainer(createNewSummary, resolvedUrl, logger)
createDocumentService(resolvedUrl, logger) Creates the document service after extracting different endpoints URLs from a resolved URL.

Constructors

RouterliciousDocumentServiceFactory.(constructor)

Constructs a new instance of the RouterliciousDocumentServiceFactory class

Signature:

constructor(tokenProvider: ITokenProvider, useDocumentService2?: boolean, errorTracking?: IErrorTrackingService, disableCache?: boolean, historianApi?: boolean, gitCache?: IGitCache | undefined, credentials?: ICredentials | undefined);

Parameters

List of parameters
Parameter Type Description
tokenProvider ITokenProvider
useDocumentService2 boolean
errorTracking IErrorTrackingService
disableCache boolean
historianApi boolean
gitCache IGitCache | undefined
credentials ICredentials | undefined

Properties

protocolName

Signature:

readonly protocolName = "fluid:";

Methods

createContainer

Signature:

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

Parameters

List of parameters
Parameter Type Description
createNewSummary ISummaryTree
resolvedUrl IResolvedUrl
logger ITelemetryBaseLogger

Returns:

Promise<IDocumentService>

createDocumentService

Creates the document service after extracting different endpoints URLs from a resolved URL.

Signature:

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

Parameters

List of parameters
Parameter Type Description
resolvedUrl IResolvedUrl URL containing different endpoint URLs.
logger ITelemetryBaseLogger

Returns:

Promise<IDocumentService>

Routerlicious document service.