Skip to main content

ILocalFluidHandleEvents Interface

Additional events which fire as a local handle's payload state transitions.

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 interface ILocalFluidHandleEvents extends IFluidHandleEvents

Extends: IFluidHandleEvents

Properties​

Property Alerts Type Description
payloadShareFailed Alpha (error: unknown) => void Emitted for locally created handles when the payload fails sharing to remote collaborators.

Property Details​

payloadShareFailed​

Emitted for locally created handles when the payload fails sharing to remote collaborators.

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​
payloadShareFailed: (error: unknown) => void;

Type: (error: unknown) => void