Skip to main content

DetachedAttributionKey Interface

AttributionKey associated with content that was inserted while the container was in a detached state.

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

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

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

Signature

export interface DetachedAttributionKey

Remarks

Retrieving an AttributionInfo from content associated with detached attribution keys is currently unsupported, as applications can effectively modify content anonymously while detached. The runtime has no mechanism for reliably obtaining the user. It would be reasonable to start supporting this functionality if the host provided additional context to their attributor or attach calls.

Properties

Property Alerts Type Description
id Alpha 0 Arbitrary discriminator associated with content inserted while detached.
type Alpha "detached"

Property Details

id

Arbitrary discriminator associated with content inserted while detached.

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

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

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

Signature

id: 0;

Type: 0

Remarks

For now, the runtime assumes all content created while detached is associated with the same user/timestamp. We could weaken this assumption in the future with further API support and allow arbitrary strings or numbers as part of this key.

type

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

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

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

Signature

type: "detached";

Type: "detached"