IOdspPointInTimeDocumentServiceImplementationProps Interface

Inputs supplied by the ODSP document service factory to an injected point-in-time implementation.

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 IOdspPointInTimeDocumentServiceImplementationProps

Properties

Property	Alerts	Modifiers	Type	Description
clientIsSummarizer	Beta	optional, readonly	boolean	Whether to apply summarizer policies and telemetry. Defaults to false.
createDocumentService	Beta	readonly	(resolvedUrl: IResolvedUrl, logger: ITelemetryBaseLogger, cacheAndTracker: ICacheAndTracker, clientIsSummarizer?: boolean) => Promise<IDocumentService>	Creates an ODSP document service for a resolved URL.
getStorageToken	Beta	readonly	TokenFetcher<OdspResourceTokenFetchOptions>	Fetches storage access tokens for ODSP requests.
logger	Beta	optional, readonly	ITelemetryBaseLogger	Optional telemetry logger for the point-in-time load.
persistedCache	Beta	readonly	IPersistedCache	The persisted ODSP cache supplied to the document service factory.
resolvedUrl	Beta	readonly	IResolvedUrl	The resolved ODSP URL for the document to materialize.
targetSequenceNumber	Beta	readonly	number	The sequence number at which to materialize the document.

Property Details

clientIsSummarizer

Whether to apply summarizer policies and telemetry. Defaults to false.

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

readonly clientIsSummarizer?: boolean;

Type: boolean

createDocumentService

Creates an ODSP document service for a resolved URL.

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

readonly createDocumentService: (resolvedUrl: IResolvedUrl, logger: ITelemetryBaseLogger, cacheAndTracker: ICacheAndTracker, clientIsSummarizer?: boolean) => Promise<IDocumentService>;

Type: (resolvedUrl: IResolvedUrl, logger: ITelemetryBaseLogger, cacheAndTracker: ICacheAndTracker, clientIsSummarizer?: boolean) => Promise<IDocumentService>

getStorageToken

Fetches storage access tokens for ODSP requests.

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

readonly getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>;

Type: TokenFetcher<OdspResourceTokenFetchOptions>

logger

Optional telemetry logger for the point-in-time load.

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

readonly logger?: ITelemetryBaseLogger;

Type: ITelemetryBaseLogger

persistedCache

The persisted ODSP cache supplied to the document service factory.

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

readonly persistedCache: IPersistedCache;

Type: IPersistedCache

resolvedUrl

The resolved ODSP URL for the document to materialize.

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

readonly resolvedUrl: IResolvedUrl;

Type: IResolvedUrl

targetSequenceNumber

The sequence number at which to materialize the document.

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

readonly targetSequenceNumber: number;

Type: number