IFluidContainerEvents Interface
Events emitted from IFluidContainer.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface IFluidContainerEvents extends IEvent
Extends: IEvent
Remarks
Note: external implementations of this interface are not supported. \
Call Signatures
| CallSignature | Description |
|---|---|
| (event: "connected", listener: () => void): void | Emitted when the IFluidContainer completes connecting to the Fluid service. |
| (event: "disconnected", listener: () => void): void | Emitted when the IFluidContainer becomes disconnected from the Fluid service. |
| (event: "saved", listener: () => void): void | Emitted when all local changes/edits have been acknowledged by the service. |
| (event: "dirty", listener: () => void): void | Emitted when the first local change has been made, following a "saved" event. |
| (event: "disposed", listener: (error?: ICriticalContainerError) => void): any | Emitted when the IFluidContainer is closed, which permanently disables it. |
Call Signature Details
(event: "connected", listener: () => void): void
Emitted when the IFluidContainer completes connecting to the Fluid service.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
(event: "connected", listener: () => void): void;
Remarks
Reflects connection state changes against the (delta) service acknowledging ops/edits.
See Also
(event: "disconnected", listener: () => void): void
Emitted when the IFluidContainer becomes disconnected from the Fluid service.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
(event: "disconnected", listener: () => void): void;
Remarks
Reflects connection state changes against the (delta) service acknowledging ops/edits.
See Also
(event: "saved", listener: () => void): void
Emitted when all local changes/edits have been acknowledged by the service.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
(event: "saved", listener: () => void): void;
Remarks
"dirty" event will be emitted when the next local change has been made.
See Also
(event: "dirty", listener: () => void): void
Emitted when the first local change has been made, following a "saved" event.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
(event: "dirty", listener: () => void): void;
Remarks
"saved" event will be emitted once all local changes have been acknowledged by the service.
See Also
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any
Emitted when the IFluidContainer is closed, which permanently disables it.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
Remarks
Listener parameters:
error: If the container was closed due to error (as opposed to an explicit call to dispose()), this will contain details about the error that caused it.