Companion

object Companion

Error codes and reasons used as values of errorCode and reason.

Properties

Link copied to clipboard

Detaching (cancelling) an in-progress attachment upload failed. Android-only.

Link copied to clipboard

An attachment failed to download.

Link copied to clipboard

Opening a downloaded attachment in an external application failed (for example, no installed app can handle the file's MIME type). Android-only.

Link copied to clipboard

Refreshing an expired attachment URL failed. Android-only; iOS exposes the same condition via attachment-fetcher events.

Link copied to clipboard

An attachment failed to upload to the Messenger service.

Link copied to clipboard

An attachment failed validation (for example, file too large or unsupported type).

Link copied to clipboard

Logout from an authenticated session failed.

Link copied to clipboard

The session requires (re-)authorization. Refresh the OpenID token and call ChatController.reauthorizeImplicitFlow(idToken, nonce) to resume the session.

Link copied to clipboard

The clear-conversation feature is disabled in the Messenger deployment configuration, so com.genesys.cloud.ui.structure.controller.ChatController.clearConversation cannot proceed. Enable the feature in Genesys Cloud admin to use it.

Link copied to clipboard

The clear-conversation feature is enabled but the operation failed (for example, because of a transient network or server error). The conversation history is not cleared and the chat session remains active.

Link copied to clipboard
const val ClientError: String

The server returned an HTTP 4xx response. Android-only; iOS surfaces client-side HTTP failures via GeneralError or ConfigurationsError.

Link copied to clipboard

The client is not authenticated but attempted an operation requiring authentication.

Link copied to clipboard

The Messenger deployment configuration could not be loaded. The chat cannot be created until the configuration becomes available.

Link copied to clipboard

The SDK could not establish or maintain the WebSocket connection to the Messenger service. Typically delivered when the device is offline or the connection is interrupted. Use com.genesys.cloud.ui.structure.controller.ChatController.reconnectChat to attempt recovery.

Link copied to clipboard

A network-layer exception (for example, java.io.IOException or java.net.SocketTimeoutException) prevented the SDK from reaching the server. Android-only.

Link copied to clipboard

The conversation could not be auto-started.

Link copied to clipboard

A new conversation could not be created.

Link copied to clipboard

Custom attributes could not be sent to the server.

Link copied to clipboard

Failed to load chat data (for example, message history).

Link copied to clipboard

The server returned an HTTP 403 (Forbidden) response. Android-only.

Link copied to clipboard
const val GeneralError: String

A general error that does not fit other categories.

Link copied to clipboard

A downloaded image exceeded the maximum allowed size and was rejected.

Link copied to clipboard
const val NotEnabled: String

The Messenger deployment is in a disabled state and cannot accept connections.

Link copied to clipboard

The server returned an HTTP 404 (Not Found) response. Android-only.

Link copied to clipboard

The push token registration request targeted a different deployment than the one the token was previously registered against. The host application should disable push for the previous deployment before registering for the new one.

Link copied to clipboard
const val ServerError: String

The server returned an HTTP 5xx response. Android-only; iOS surfaces server failures via GeneralError or ConnectionError.

Link copied to clipboard

The Messenger service is temporarily unavailable (for example, during an outage or maintenance window). Retry the operation later.

Link copied to clipboard

The chat session ended because the session expired (for example, idle timeout).

Link copied to clipboard

A message failed to send.

Link copied to clipboard
const val TimeOutError: String

The request timed out (HTTP 504, or a socket/read timeout). Android-only; iOS surfaces timeouts via ConnectionError.