Skip to main content

ConnectionStatusConnected Interface

Status for a full connection.

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 ConnectionStatusConnected extends ConnectionStatusTemplate

Extends: ConnectionStatusTemplate

Properties

Property Alerts Type Description
canSendOps Beta boolean
clientConnectionId Beta string The ID of the client connection that is connected.
connectionState Beta ConnectionState.Connected

Property Details

canSendOps

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

clientConnectionId

The ID of the client connection that is 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
clientConnectionId: string;

Type: string

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.Connected;

Type: ConnectionState.Connected