Skip to main content

PayloadState TypeAlias

The state of the handle's payload. - "pending" - The payload is not shared to all collaborators - "shared" - The payload is available to both the local client and remote collaborators

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

To use, import via @fluidframework/core-interfaces/legacy.

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

Signature

export type PayloadState = "pending" | "shared";

Remarks

Clients will see a transition of "pending" to "shared" when the payload has been shared to all collaborators.