ConnectionStatusTemplate Interface

Defines the connection status of the container.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-definitions/legacy.

For more information about our API support guarantees, see here.

Sealed

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 ConnectionStatusTemplate

Properties

Property	Alerts	Type	Description
canSendOps	Beta	boolean	True if the runtime is currently allowed to send ops.
connectionState	Beta	ConnectionState
readonly	Beta	boolean	True if the container is in readonly mode.

Property Details

canSendOps

True if the runtime is currently allowed to send ops.

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

canSendOps: boolean;

Type: boolean

connectionState

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

connectionState: ConnectionState;

Type: ConnectionState

readonly

True if the container is in readonly mode.

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: boolean;

Type: boolean