IDocumentServiceFactory Interface
Packages > @fluidframework/driver-definitions > IDocumentServiceFactory
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/driver-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface IDocumentServiceFactory
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| createContainer(createNewSummary, createNewResolvedUrl, logger, clientIsSummarizer) |
Alpha
|
Promise<IDocumentService> | Creates a new document with the provided options. Returns the document service. |
| createDocumentService(resolvedUrl, logger, clientIsSummarizer) |
Alpha
|
Promise<IDocumentService> | Creates the document service after extracting different endpoints URLs from a resolved URL. |
Method Details
createContainer
Creates a new document with the provided options. Returns the document service.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
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.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/driver-definitions/alpha.
For more information about our API support guarantees, see here .
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 >