Session

abstract class Session

Represents a managed connection to a Room which can contain an Agent.

Constructors

constructor()

abstract val connectionState: ConnectionState

The ConnectionState of the session.

Whether the session is connected or not.

Whether the session is reconnecting or not.

abstract val room: Room

The Room object used for this session.

abstract fun end()

Disconnect from the session.

abstract suspend fun prepareConnection()

Prepares the connection to speed up initial connection time.

abstract suspend fun start(options: SessionConnectOptions = SessionConnectOptions()): Result<Unit>

Connect to the session.

abstract suspend fun waitUntilConnected()

A function that suspends until the session is connected.

abstract suspend fun waitUntilDisconnected()

A function that suspends until the session is disconnected.