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 | Alpha |
readonly |
Listenable<IFluidHandleEvents & ILocalFluidHandleEvents> | Event emitter, with events that emit as the payload state transitions. |
| payloadShareError | Alpha |
readonly |
unknown | The error encountered by the handle while sharing the payload, if one has occurred. Undefined if no error has occurred. |
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