IConnectableRuntime Interface
This API is deprecated and will be removed in a future release.
This type will be moved to internal in 2.30. External usage is not necessary or supported.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/container-runtime/legacy.
For more information about our API support guarantees, see here.
Signature
export interface IConnectableRuntime
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| clientId | Alpha |
readonly |
string | undefined | |
| connected | Alpha |
readonly |
boolean | |
| disposed | Alpha |
readonly |
boolean |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| once(event, listener) | Alpha |
this |
Property Details
clientId
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 clientId: string | undefined;
Type: string | undefined
connected
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 connected: boolean;
Type: boolean
disposed
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 disposed: boolean;
Type: boolean
Method Details
once
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
once(event: "connected" | "disconnected" | "dispose", listener: () => void): this;
Parameters
| Parameter | Type | Description |
|---|---|---|
| event | "connected" | "disconnected" | "dispose" | |
| listener | () => void |
Returns
Return type: this