HostStoragePolicy Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/odsp-driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface HostStoragePolicy

Properties

Property	Alerts	Modifiers	Type	Description
avoidPrefetchSnapshotCache	Alpha	optional	boolean	True if host does not want the storage service to use the prefetch cache to get the snapshot. Undefined will be treated as false. This is if the host wants to do some A/B testing.
cacheCreateNewSummary	Alpha	optional	boolean	Policy controlling if we will cache initial summary when we create a document
concurrentOpsBatches	Alpha	optional	number
concurrentSnapshotFetch	Alpha	optional	boolean	If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache Container loads from whatever comes first in such case. Snapshot fetched from storage is pushed to cache in either case. If set to false, driver will first consult with cache. Only on cache miss (cache does not return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise it will load from cache and not reach out to storage. Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.
enableRedeemFallback	Deprecated, Alpha	optional	boolean
enableShareLinkWithCreate	Deprecated, Alpha	optional	boolean
enableSingleRequestForShareLinkWithCreate	Alpha	optional	boolean	Enable creation of sharing link along with the creation of file by setting this value to true. If the host provides a 'createLinkScope' parameter in the request URL to the container.attach() method, we will send the request to ODSP with the same (if the flag is enabled) so that a share link can be created with the creation of file to save number for round trips made to ODSP. (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests where 'createLinkType' was requested.)
fetchBinarySnapshotFormat	Deprecated, Alpha	optional	boolean
isolateSocketCache	Alpha	optional	boolean	If set to true, socket cache are per OdspDocumentService instead of shared across all instances
opsBatchSize	Alpha	optional	number
opsCaching	Alpha	optional	IOpsCachingPolicy	Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)
sessionOptions	Alpha	optional	ICollabSessionOptions	Policy controlling how collaboration session is established
snapshotOptions	Alpha	optional	ISnapshotOptions

Property Details

avoidPrefetchSnapshotCache

True if host does not want the storage service to use the prefetch cache to get the snapshot. Undefined will be treated as false. This is if the host wants to do some A/B testing.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

avoidPrefetchSnapshotCache?: boolean;

Type: boolean

cacheCreateNewSummary

Policy controlling if we will cache initial summary when we create a document

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

cacheCreateNewSummary?: boolean;

Type: boolean

concurrentOpsBatches

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

concurrentOpsBatches?: number;

Type: number

concurrentSnapshotFetch

If set to true, tells driver to concurrently fetch snapshot from storage (SPO) and cache Container loads from whatever comes first in such case. Snapshot fetched from storage is pushed to cache in either case. If set to false, driver will first consult with cache. Only on cache miss (cache does not return snapshot), driver will fetch snapshot from storage (and push it to cache), otherwise it will load from cache and not reach out to storage. Passing true results in faster loads and keeping cache more current, but it increases bandwidth consumption.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

concurrentSnapshotFetch?: boolean;

Type: boolean

enableRedeemFallback

This API is deprecated and will be removed in a future release.

This field will be always set to true after removal. True to have the sharing link redeem fallback in case the Trees Latest/Redeem 1RT call fails with redeem error. During fallback it will first redeem the sharing link and then make the Trees latest call.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

enableRedeemFallback?: boolean;

Type: boolean

enableShareLinkWithCreate

This API is deprecated and will be removed in a future release.

Switch to using the new feature gated by enableSingleRequestForShareLinkWithCreate with 'createLinkScope' and 'createLinkRole' is requested to the odsp apis instead of 'createLinkType'. It enables the creation of sharing link along with the creation of file by setting this value to true. If the host provides a 'createLinkType' parameter in the request URL to the container.attach() method, we will send the request to ODSP with the same (if the flag is enabled) so that a share link can be created with the creation of file to save number for round trips made to ODSP. (This flag works independently of enableSingleRequestForShareLinkWithCreate which is used for sharing link requests where 'createLinkScope' is requested.)

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

enableShareLinkWithCreate?: boolean;

Type: boolean

enableSingleRequestForShareLinkWithCreate

Enable creation of sharing link along with the creation of file by setting this value to true. If the host provides a 'createLinkScope' parameter in the request URL to the container.attach() method, we will send the request to ODSP with the same (if the flag is enabled) so that a share link can be created with the creation of file to save number for round trips made to ODSP. (This flag works independently of enableShareLinkWithCreate which was used for old sharing link requests where 'createLinkType' was requested.)

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

enableSingleRequestForShareLinkWithCreate?: boolean;

Type: boolean

fetchBinarySnapshotFormat

This API is deprecated and will be removed in a future release.

This will be replaced with feature gate snapshotFormatFetchType. Policy controlling if we want to fetch binary format snapshot.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

fetchBinarySnapshotFormat?: boolean;

Type: boolean

isolateSocketCache

If set to true, socket cache are per OdspDocumentService instead of shared across all instances

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

isolateSocketCache?: boolean;

Type: boolean

opsBatchSize

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

opsBatchSize?: number;

Type: number

opsCaching

Policy controlling ops caching (leveraging IPersistedCache passed to driver factory)

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

opsCaching?: IOpsCachingPolicy;

Type: IOpsCachingPolicy

sessionOptions

Policy controlling how collaboration session is established

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

sessionOptions?: ICollabSessionOptions;

Type: ICollabSessionOptions

snapshotOptions

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/odsp-driver-definitions/alpha.

For more information about our API support guarantees, see here.

Signature

snapshotOptions?: ISnapshotOptions;

Type: ISnapshotOptions