IDocumentServicePolicies Interface

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

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

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

Signature

export interface IDocumentServicePolicies

Properties

Property	Alerts	Modifiers	Type	Description
storageOnly	Alpha	optional, readonly	boolean	Do not connect to delta stream
summarizeProtocolTree	Alpha	optional, readonly	boolean	Summarizer uploads the protocol tree too when summarizing.
supportGetSnapshotApi	Alpha	optional, readonly	boolean	Whether the driver supports the new getSnapshot api which returns snapshot which contains all contents along with the snapshot tree. Enable this by default when the driver can fully support the api.

Property Details

storageOnly

Do not connect to delta stream

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

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

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

Signature

readonly storageOnly?: boolean;

Type: boolean

summarizeProtocolTree

Summarizer uploads the protocol tree too when summarizing.

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

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

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

Signature

readonly summarizeProtocolTree?: boolean;

Type: boolean

supportGetSnapshotApi

Whether the driver supports the new getSnapshot api which returns snapshot which contains all contents along with the snapshot tree. Enable this by default when the driver can fully support the api.

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

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

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

Signature

readonly supportGetSnapshotApi?: boolean;

Type: boolean