IDocumentServiceFactory Interface
Signature
export interface IDocumentServiceFactory
Properties
| Property | Type | Description |
|---|---|---|
| protocolName | string | Name of the protocol used by factory |
Methods
| Method | Return Type | Description |
|---|---|---|
| createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) | Promise<IDocumentService> | Creates a new document with the provided options. Returns the document service. |
| createDocumentService(resolvedUrl, logger, clientIsSummarizer) | Promise<IDocumentService> | Creates the document service after extracting different endpoints URLs from a resolved URL. |
Property Details
protocolName
Name of the protocol used by factory
Signature
protocolName: string;
Type: string
Method Details
createContainer
Creates a new document with the provided options. Returns the document service.
Signature
createContainer(createNewSummary: ISummaryTree | undefined, createNewResolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| createNewSummary | ISummaryTree | undefined | Summary used to create file. If undefined, an empty file will be created and a summary should be posted later, before connecting to ordering service. | |
| createNewResolvedUrl | IResolvedUrl | Endpoint URL data. See IResolvedUrl. | |
| logger | optional | ITelemetryBaseLogger | Optional telemetry logger to which telemetry events will be forwarded. |
| clientIsSummarizer | optional | boolean | Whether or not the client is the summarizer. undefined => false |
Returns
Return type: Promise<IDocumentService>
createDocumentService
Creates the document service after extracting different endpoints URLs from a resolved URL.
Signature
createDocumentService(resolvedUrl: IResolvedUrl, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| resolvedUrl | IResolvedUrl | Endpoint URL data. See IResolvedUrl. | |
| logger | optional | ITelemetryBaseLogger | Optional telemetry logger to which telemetry events will be forwarded. |
| clientIsSummarizer | optional | boolean | Whether or not the client is the summarizer. undefined => false |
Returns
An instance of IDocumentService.
Return type: Promise<IDocumentService>