Skip to main content

IAttachMessage Interface

Message send by client attaching local data structure. Contains snapshot of data structure which is the current state of this data structure.

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 IAttachMessage

Properties

PropertyAlertsTypeDescription
idBetastringThe identifier for the object
snapshotBetaITreeInitial snapshot of the document (contains ownership)
typeBetastringThe type of object

Property Details

id

The identifier for the object

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

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

Signature

id: string;

Type: string

snapshot

Initial snapshot of the document (contains ownership)

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

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

Signature

snapshot: ITree;

Type: ITree

type

The type of object

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

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

Signature

type: string;

Type: string