FileDocumentServiceFactory Class
Factory for creating the file document service. Use this if you want to use the local file storage as underlying storage.
Signature
export declare class FileDocumentServiceFactory implements IDocumentServiceFactory
Implements: IDocumentServiceFactory
Constructors
| Constructor | Description |
|---|---|
| (constructor)(storage, deltaStorage, deltaConnection) | Constructs a new instance of the FileDocumentServiceFactory class |
Properties
| Property | Type | Description |
|---|---|---|
| protocolName |
Methods
| Method | Return Type | Description |
|---|---|---|
| createContainer(createNewSummary, resolvedUrl, logger, clientIsSummarizer) | Promise<IDocumentService> | |
| createDocumentService(fileURL, logger, clientIsSummarizer) | Promise<IDocumentService> | Creates the file document service if the path exists. |
Constructor Details
(constructor)
Constructs a new instance of the FileDocumentServiceFactory class
Signature
constructor(storage: IDocumentStorageService, deltaStorage: FileDeltaStorageService, deltaConnection: IDocumentDeltaConnection);
Parameters
| Parameter | Type | Description |
|---|---|---|
| storage | IDocumentStorageService | |
| deltaStorage | FileDeltaStorageService | |
| deltaConnection | IDocumentDeltaConnection |
Property Details
protocolName
Signature
readonly protocolName = "fluid-file:";
Method Details
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 the file document service if the path exists.
Signature
createDocumentService(fileURL: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| fileURL | IResolvedUrl | Path of directory containing ops/snapshots. | |
| logger | optional | ITelemetryBaseLogger | |
| clientIsSummarizer | optional | boolean |
Returns
file document service.
Return type: Promise<IDocumentService>