OdspDocumentServiceFactoryCore Class

Factory for creating the sharepoint document service. Use this if you want to use the sharepoint implementation.

This constructor should be used by environments that support dynamic imports and that wish to leverage code splitting as a means to keep bundles as small as possible.

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 declare class OdspDocumentServiceFactoryCore implements IDocumentServiceFactory, IRelaySessionAwareDriverFactory

Implements: IDocumentServiceFactory, IRelaySessionAwareDriverFactory

Constructors

Constructor	Alerts	Description
(constructor)(getStorageToken, getWebsocketToken, persistedCache, hostPolicy)	Alpha	Constructs a new instance of the OdspDocumentServiceFactoryCore class

Properties

Property	Alerts	Modifiers	Type	Description
IRelaySessionAwareDriverFactory	Alpha	readonly	this
persistedCache	Alpha		IPersistedCache
snapshotPrefetchResultCache	Alpha	readonly	PromiseCache<string, IPrefetchSnapshotContents>

Constructor Details

(constructor)

Constructs a new instance of the OdspDocumentServiceFactoryCore class

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

constructor(getStorageToken: TokenFetcher<OdspResourceTokenFetchOptions>, getWebsocketToken: TokenFetcher<OdspResourceTokenFetchOptions> | undefined, persistedCache?: IPersistedCache, hostPolicy?: HostStoragePolicy);

Parameters

Parameter	Modifiers	Type	Description
getStorageToken		TokenFetcher<OdspResourceTokenFetchOptions>	function that can provide the storage token for a given site. This is is also referred to as the "Vroom" token in SPO.
getWebsocketToken		TokenFetcher<OdspResourceTokenFetchOptions> | undefined	function that can provide a token for accessing the web socket. This is also to as the "Push" token in SPO. If undefined then websocket token is expected to be returned with joinSession response payload.
persistedCache	optional	IPersistedCache	PersistedCache provided by host for use in this session.
hostPolicy	optional	HostStoragePolicy	Policy for storage provided by host.

Property Details

IRelaySessionAwareDriverFactory

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

get IRelaySessionAwareDriverFactory(): this;

Type: this

persistedCache

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

protected persistedCache: IPersistedCache;

Type: IPersistedCache

snapshotPrefetchResultCache

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

get snapshotPrefetchResultCache(): PromiseCache<string, IPrefetchSnapshotContents>;

Type: PromiseCache<string, IPrefetchSnapshotContents>