Skip to main content
Version: v1

StaticStorageDocumentServiceFactory Class

Signature​

export declare class StaticStorageDocumentServiceFactory implements IDocumentServiceFactory

Implements: IDocumentServiceFactory

Constructors​

ConstructorDescription
(constructor)(storage)Constructs a new instance of the StaticStorageDocumentServiceFactory class

Properties​

PropertyTypeDescription
protocolName
storageIDocumentStorageService

Methods​

MethodReturn TypeDescription
createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer)Promise<IDocumentService>
createDocumentService(fileURL, logger, clientIsSummarizer)Promise<IDocumentService>

Constructor Details​

(constructor)​

Constructs a new instance of the StaticStorageDocumentServiceFactory class

Signature​

constructor(storage: IDocumentStorageService);

Parameters​

ParameterTypeDescription
storageIDocumentStorageService

Property Details​

protocolName​

Signature​

readonly protocolName = "fluid-static-storage:";

storage​

Signature​

protected readonly storage: IDocumentStorageService;

Type: IDocumentStorageService

Method Details​

createContainer​

Signature​

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

Parameters​

ParameterModifiersTypeDescription
createNewSummaryISummaryTree
resolvedUrlIResolvedUrl
loggerITelemetryLogger
clientIsSummarizeroptionalboolean

Returns​

Return type: Promise<IDocumentService>

createDocumentService​

Signature​

createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;

Parameters​

ParameterModifiersTypeDescription
fileURLIResolvedUrl
loggeroptionalITelemetryLogger
clientIsSummarizeroptionalboolean

Returns​

Return type: Promise<IDocumentService>