Genesys Messenger Mobile SDK/com.genesys.cloud.integration.core/EndedReason

EndedReason

The reason a chat session ended.

This value is delivered as the StateEvent.data payload when the chat transitions to StateEvent.Ended or StateEvent.Closed. Most integrators read it on StateEvent.Closed (the terminal state); StateEvent.Ended also carries it in cases such as a force-close, an idle timeout, or a recoverable disconnect.

Entries

Unknown

The chat ended for an unknown or unexpected reason.

Operator

The chat was ended by an agent or operator.

Visitor

The chat was ended by the user (visitor) while the session was still active.

Disconnected

The chat was disconnected.

SessionLimitReached

The connection was closed because the maximum number of simultaneous open sessions was exceeded.

Logout

The connection was closed following a successful logout from an authenticated session.

ConversationCleared

The connection was closed as a result of calling clear conversation on the chat controller.

App

The chat was terminated by the hosting application.

SessionHasExpired

The session ended due to inactivity timeout.

Properties

entries

val entries: EnumEntries<EndedReason>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): EndedReason

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<EndedReason>

Returns an array containing the constants of this enum type, in the order they're declared.