Skip to main content

OpAttributionKey Interface

AttributionKey representing a reference to some op in the op stream. Content associated with this key aligns with content modified by that op.

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 OpAttributionKey

Properties

Property Alerts Type Description
seq Alpha number The sequenceNumber of the op this attribution key is for.
type Alpha "op"

The type of attribution this key corresponds to.

Keys currently all represent op-based attribution, so have the form { type: "op", key: sequenceNumber }. Thus, they can be used with an OpStreamAttributor to recover timestamp/user information.

Property Details

seq

The sequenceNumber of the op this attribution key is for.

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

seq: number;

Type: number

type

The type of attribution this key corresponds to.

Keys currently all represent op-based attribution, so have the form { type: "op", key: sequenceNumber }. Thus, they can be used with an OpStreamAttributor to recover timestamp/user information.

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: "op";

Type: "op"