IFluidContainerEvents Interface

Events emitted from IFluidContainer.

Signature

export interface IFluidContainerEvents extends IEvent

Extends: IEvent

Remarks

The following is the list of events emitted.

### "connected"

The "connected" event is emitted when the IFluidContainer completes connecting to the Fluid service.

#### Listener signature

() => void;

### "disposed"

The "disposed" event is emitted when the IFluidContainer is disposed, which permanently disables it.

#### Listener signature

() => void;

### "disconnected"

The "disconnected" event is emitted when the IFluidContainer becomes disconnected from the Fluid service.

#### Listener signature

() => void;

### "saved"

The "saved" event is emitted when the IFluidContainer has local changes acknowledged by the service.

#### Listener signature

() => void

### "dirty"

The "dirty" event is emitted when the IFluidContainer has local changes that have not yet been acknowledged by the service.

#### Listener signature

() => void

Call Signatures

CallSignature	Description
(event: "connected" | "disconnected", listener: () => void): void	**connected** & **disconnected** events reflect connection state changes against the (delta) service acknowledging ops/edits.
(event: "saved" | "dirty", listener: () => void): void	**saved** event is raised when all local changes/edits have been acknowledged by the service. **dirty** event is raised when first local change has been made, following a "saved" state.
(event: "disposed", listener: (error?: ICriticalContainerError) => void): any	Disposed event is raised when container is closed. If container was closed due to error (vs explicit **dispose** action), optional argument contains further details about the error.

Call Signature Details

(event: "connected" | "disconnected", listener: () => void): void

**connected** & **disconnected** events reflect connection state changes against the (delta) service acknowledging ops/edits.

Signature

(event: "connected" | "disconnected", listener: () => void): void;

(event: "saved" | "dirty", listener: () => void): void

**saved** event is raised when all local changes/edits have been acknowledged by the service. **dirty** event is raised when first local change has been made, following a "saved" state.

Signature

(event: "saved" | "dirty", listener: () => void): void;

(event: "disposed", listener: (error?: ICriticalContainerError) => void): any

Disposed event is raised when container is closed. If container was closed due to error (vs explicit **dispose** action), optional argument contains further details about the error.

Signature

(event: "disposed", listener: (error?: ICriticalContainerError) => void): any;