ConnectionStatusCatchingUp Interface
Status for an in-progress connection that is catching up to latest op state.
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 ConnectionStatusCatchingUp extends ConnectionStatusTemplate
Extends: ConnectionStatusTemplate
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| canSendOps | Beta | false | |
| connectionState | Beta | ConnectionState.CatchingUp | |
| pendingClientConnectionId | Beta | string | The ID of the client connection that is connecting. |
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.CatchingUp;
Type: ConnectionState.CatchingUp
pendingClientConnectionId
The ID of the client connection that is connecting.
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
pendingClientConnectionId: string;
Type: string