ISessionClient Interface

A client within a Fluid session (period of container connectivity to service).

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

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

Signature

/** @sealed */
export interface ISessionClient<SpecificSessionClientId extends ClientSessionId = ClientSessionId>

Type Parameters

Parameter	Constraint	Default	Description
SpecificSessionClientId	ClientSessionId	ClientSessionId

Remarks

Note: This is very preliminary session client representation.

ISessionClient should be used as key to distinguish between different clients as they join, rejoin, and disconnect from a session. While a client's ClientConnectionId from getConnectionStatus() may change over time, ISessionClient will be fixed.

Properties

Property	Alerts	Modifiers	Type	Description
sessionId	Alpha	readonly	SpecificSessionClientId	The session ID of the client that is stable over all connections.

Methods

Method	Alerts	Return Type	Description
getConnectionId()	Alpha	ClientConnectionId	Get current client connection ID.
getConnectionStatus()	Alpha	SessionClientStatus	Get connection status of session client.

Property Details

sessionId

The session ID of the client that is stable over all connections.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

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

Signature

readonly sessionId: SpecificSessionClientId;

Type: SpecificSessionClientId

Method Details

getConnectionId

Get current client connection ID.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

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

Signature

getConnectionId(): ClientConnectionId;

Remarks

Connection ID will change on reconnect.

If getConnectionStatus() is (SessionClientStatus:variable).Disconnected, this will represent the last known connection ID.

Returns

Current client connection ID.

Return type: ClientConnectionId

getConnectionStatus

Get connection status of session client.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/presence/alpha.

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

Signature

getConnectionStatus(): SessionClientStatus;

Returns

Connection status of session client.

Return type: SessionClientStatus