Packages > @fluidframework/merge-tree > IMergeTreeAttributionOptions

IMergeTreeAttributionOptions Interface

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

To use, import via @fluidframework/merge-tree/legacy.

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

Signature

export interface IMergeTreeAttributionOptions

Properties

Property Alerts Modifiers Type Description
policyFactory Alpha optional () => AttributionPolicy Provides a policy for how to track attribution data on segments. This option must be provided if either: - track is set to true - a document containing existing attribution information is loaded
track Alpha optional boolean

If enabled, segments will store attribution keys which can be used with the runtime to determine attribution information (i.e. who created the content and when it was created).

This flag only applied to new documents: if a snapshot is loaded, whether or not attribution keys are tracked is determined by the presence of existing attribution keys in the snapshot.

default: false

Property Details

policyFactory

Provides a policy for how to track attribution data on segments. This option must be provided if either: - track is set to true - a document containing existing attribution information is loaded

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

To use, import via @fluidframework/merge-tree/alpha.

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

Signature

policyFactory?: () => AttributionPolicy;

Type: () => AttributionPolicy

track

If enabled, segments will store attribution keys which can be used with the runtime to determine attribution information (i.e. who created the content and when it was created).

This flag only applied to new documents: if a snapshot is loaded, whether or not attribution keys are tracked is determined by the presence of existing attribution keys in the snapshot.

default: false

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

To use, import via @fluidframework/merge-tree/alpha.

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

Signature

track?: boolean;

Type: boolean