IPointInTimeDocumentServiceFactory Interface
An ODSP document service factory that supports point-in-time (sequence-number-based) loading.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/odsp-driver/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IPointInTimeDocumentServiceFactory extends IDocumentServiceFactory
Extends: IDocumentServiceFactory
Remarks
The loader detects this capability structurally, so hosts can pass this factory directly to loadContainerToSequenceNumber(props).
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| createPointInTimeDocumentService(resolvedUrl, targetSequenceNumber, logger, clientIsSummarizer) | Beta | Promise<IDocumentService> | Creates a document service that materializes the document at the requested sequence number. |
Method Details
createPointInTimeDocumentService
Creates a document service that materializes the document at the requested sequence number.
This API is provided for existing users, but is not recommended for new users.
For more information about our API support guarantees, see here.
Signature
createPointInTimeDocumentService(resolvedUrl: IResolvedUrl, targetSequenceNumber: number, logger?: ITelemetryBaseLogger, clientIsSummarizer?: boolean): Promise<IDocumentService>;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| resolvedUrl | IResolvedUrl | The resolved ODSP IResolvedUrl. | |
| targetSequenceNumber | number | The sequence number at which to materialize the document. See loadToSequenceNumber. | |
| logger | optional | ITelemetryBaseLogger | Optional ITelemetryBaseLogger. |
| clientIsSummarizer | optional | boolean | Whether to apply summarizer policies and telemetry to the underlying document services. Defaults to false. |
Returns
A read-only IDocumentService materialized at the requested sequence number.
Return type: Promise<IDocumentService>