ConnectionStatusDisconnected Interface

Status for a disconnected 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 ConnectionStatusDisconnected extends ConnectionStatusTemplate

Extends: ConnectionStatusTemplate

Properties

Property	Alerts	Type	Description
canSendOps	Beta	false
connectionState	Beta	ConnectionState.Disconnected
priorConnectedClientConnectionId	Beta	string | undefined	The ID of the client connection that was most recently connected.
priorPendingClientConnectionId	Beta	string | undefined	The ID of the client connection that was most recently connecting (catching up).

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

Type: false

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

Type: ConnectionState.Disconnected

priorConnectedClientConnectionId

The ID of the client connection that was most recently 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

priorConnectedClientConnectionId: string | undefined;

Type: string | undefined

priorPendingClientConnectionId

The ID of the client connection that was most recently connecting (catching up).

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

priorPendingClientConnectionId: string | undefined;

Type: string | undefined