IFluidHandlePayloadPending Interface
Observable state on the 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 IFluidHandlePayloadPending<T> extends IFluidHandle<T>
Extends: IFluidHandle<T>
Type Parameters
| Parameter | Description |
|---|---|
| T |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| events | Alpha |
readonly |
Listenable<IFluidHandleEvents> | Event emitter, with events that emit as the payload state transitions. |
| payloadState | Alpha |
readonly |
PayloadState | The current state of the handle's payload. |
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>;
Type: Listenable<IFluidHandleEvents>
payloadState
The current state of the handle's payload.
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 payloadState: PayloadState;
Type: PayloadState