Companion

object Companion

The chat lifecycle states used as values of state.

Properties

Link copied to clipboard

The chat UI fragment has been created and attached, but the chat content has not finished loading yet.

Link copied to clipboard

The chat UI fragment has been detached from its host (for example, after the user navigates away). The chat session itself may still be active in the background.

Link copied to clipboard

The chat UI fragment has finished loading and the chat is ready to be interacted with.

Link copied to clipboard
const val Closed: String

The chat has fully closed and resources have been released. The data of this event contains the EndedReason.

Link copied to clipboard
const val Created: String

The chat session object has been created but the connection has not started.

Link copied to clipboard
const val Disconnected: String

The connection was lost unexpectedly.

Link copied to clipboard
const val Ended: String

The chat session has ended. The data of this event contains the EndedReason.

Link copied to clipboard

The chat session was ended by an agent or operator. Delivered to the listener as a separate event in addition to the Ended/Closed sequence.

Link copied to clipboard
const val Ending: String

The chat session is in the process of ending (graceful shutdown initiated).

Link copied to clipboard
const val Idle: String

The chat is idle: either it has not been started yet, or the previous session has been fully closed and the controller is ready for a new session.

Link copied to clipboard
const val Prepared: String

Configuration has been fetched and the chat is ready to be presented.

Link copied to clipboard
const val Preparing: String

The SDK is establishing the connection and fetching configuration.

Link copied to clipboard
const val Reconnected: String

The connection has been successfully re-established after a disconnect.

Link copied to clipboard
const val Reconnecting: String

The SDK is attempting to re-establish the connection after an unexpected disconnect.

Link copied to clipboard
const val Started: String

The chat session is active and messages can be exchanged.

Link copied to clipboard
const val Unavailable: String

The chat deployment is unavailable (for example, outside business hours or disabled).