Genesys Messenger Mobile SDK/com.genesys.cloud.ui.structure.controller/ChatController

ChatController

class ChatController : ConfinedChatHandler

The primary entry point for integrating the Genesys Cloud chat experience into a host application.

ChatController manages the lifecycle of a chat session, including starting, ending, reconnecting, and presenting the chat UI. The host application creates an instance from a configured MessengerAccount using Builder, and registers a ChatEventListener to receive lifecycle callbacks.

Prerequisites:

A valid MessengerAccount configured with a deployment ID and domain.
A ChatEventListener passed to Builder.chatEventListener before calling Builder.build.

Usage:

val account = MessengerAccount(
    deploymentId = "your-deployment-id",
    domain = "your-domain.com"
).apply {
    logging = true
    sessionExpirationNoticeInterval = 300
}

val chatController = ChatController.Builder(context)
    .chatEventListener(this)
    .build(account, chatLoadedListener)

Important: Builder.build initiates the chat session and the chat UI Fragment is delivered via ChatLoadedListener.onComplete. Ensure the account is fully configured before calling it.

Types

Builder for creating and configuring a ChatController instance.

Properties

chatEventListener

var chatEventListener: ChatEventListener?

The listener that receives state changes, errors, and chat elements, or null if none is registered.

open override val isActive: Boolean

Chat in progress

open override val isLiveChat: Boolean

Chat with agent

val wasDestructed: Boolean

Indicates whether this controller has already been destroyed.

Functions

clearConversation

open override fun clearConversation()

Clears the current conversation history from the session.

open override fun destruct()

Destroys this controller and releases all associated resources.

open override fun endChat(forceClose: Boolean = false)

Ends the current chat session.

fun hasOpenChats(): Boolean

Returns true if ChatController has open chats

open override fun isEnabled(name: String, default: Boolean? = null, data: Any? = null): Boolean?

Returns name enalability value if recognized.

logoutFromAuthenticatedSession

open override fun logoutFromAuthenticatedSession()

Logs out from the current authenticated session.

reauthorizeImplicitFlow

fun reauthorizeImplicitFlow(idToken: String, nonce: String)

Reauthorizes the implicit authentication flow with a new token after expiration.

open override fun reconnectChat()

Attempts to reconnect a disconnected chat session.

fun restoreChat(fragment: Fragment? = null, account: AccountInfo? = null)

Start new chat or Continue an open chat. Chat fragment can be provided by the app - as in case of restoring activity

open override fun startChat(accountInfo: AccountInfo)

Starts new chat with provided account. Configured as restorable, won't end on UI removal.

fun terminateChat()

Terminates the active chat session and releases the underlying chat handler immediately.

updateCustomAttributes

open override fun updateCustomAttributes(customAttributes: Map<String, String>)

Updates the custom attributes associated with the current chat session.