IOdspDocumentServiceFactoryOptions Interface

Options for creating an ODSP document service factory.

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 IOdspDocumentServiceFactoryOptions

Properties

Property	Alerts	Modifiers	Type	Description
getStorageToken	Beta	readonly	TokenFetcher<OdspResourceTokenFetchOptions>	Fetches storage access tokens.
getWebsocketToken	Beta	readonly	TokenFetcher<OdspResourceTokenFetchOptions> | undefined	Fetches websocket access tokens, or undefined when unavailable.
hostPolicy	Beta	optional, readonly	HostStoragePolicy | undefined	Host storage policy. When omitted, the default driver policies are used.
persistedCache	Beta	optional, readonly	IPersistedCache | undefined	Persisted ODSP cache. When omitted, a local in-memory cache is used.
pointInTimeDocumentServiceImplementation	Beta	optional, readonly	OdspPointInTimeDocumentServiceImplementation | undefined	Enables point-in-time loading. Consumers that omit this implementation do not include the feature code in their dependency graph.

Property Details

getStorageToken

Fetches storage access tokens.

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>

getWebsocketToken

Fetches websocket access tokens, or undefined when unavailable.

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 getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined;

Type: TokenFetcher<OdspResourceTokenFetchOptions> | undefined

hostPolicy

Host storage policy. When omitted, the default driver policies are used.

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 hostPolicy?: HostStoragePolicy | undefined;

Type: HostStoragePolicy | undefined

persistedCache

Persisted ODSP cache. When omitted, a local in-memory cache is used.

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 | undefined;

Type: IPersistedCache | undefined

pointInTimeDocumentServiceImplementation

Enables point-in-time loading. Consumers that omit this implementation do not include the feature code in their dependency graph.

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 pointInTimeDocumentServiceImplementation?: OdspPointInTimeDocumentServiceImplementation | undefined;

Type: OdspPointInTimeDocumentServiceImplementation | undefined