ILocalFluidHandle Interface

Additional observable state on a local handle regarding its payload sharing state.

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 ILocalFluidHandle<T> extends IFluidHandlePayloadPending<T>

Extends: IFluidHandlePayloadPending<T>

Type Parameters

Parameter	Description
T

Properties

Property	Alerts	Modifiers	Type	Description
events	Beta	readonly	Listenable<IFluidHandleEvents & ILocalFluidHandleEvents>	Event emitter, with events that emit as the payload state transitions.
payloadShareError	Beta	readonly	unknown	The error encountered by the handle while sharing the payload, if one has occurred. Undefined if no error has occurred.

Methods

Method	Alerts	Modifiers	Return Type	Description
sharePayload()	Beta	optional	void	Starts sharing the handle's payload without attaching the handle to the Fluid object graph.

Property Details

events

Event emitter, with events that emit as the payload state transitions.

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

readonly events: Listenable<IFluidHandleEvents & ILocalFluidHandleEvents>;

Type: Listenable<IFluidHandleEvents & ILocalFluidHandleEvents>

payloadShareError

The error encountered by the handle while sharing the payload, if one has occurred. Undefined if no error has occurred.

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

readonly payloadShareError: unknown;

Type: unknown

Method Details

sharePayload

Starts sharing the handle's payload without attaching the handle to the Fluid object graph.

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

sharePayload?(): void;

Remarks

This method starts the same asynchronous payload-sharing process that normally begins when the handle is attached. Calling it multiple times has no additional effect, and calling it for an already-shared payload is a no-op.

This method does not wait for the payload to be uploaded or shared. Progress and failures can be observed through events.