Genesys Messenger Mobile SDK/com.genesys.cloud.core.utils/NRError

NRError

open class NRError @JvmOverloads constructor(var errorCode: String = GeneralError, var reason: String? = Unknown, var description: String? = null, var data: Any? = null)

Represents a failure that can occur during a chat session.

Errors are delivered through ChatEventListener.onError. Use errorCode to determine the type of failure and the appropriate recovery action in your application.

Handling errors:

override fun onError(error: NRError) {
    when (error.errorCode) {
        NRError.AuthorizationRequired -> {
            // Re-authenticate and call ChatController.reauthorizeImplicitFlow.
        }
        NRError.AttachmentValidationError -> {
            // Inform the user about file size/type restrictions.
        }
        NRError.ClientNotAuthenticatedError, NRError.AuthLogoutError -> {
            // Return the user to the login screen.
        }
        else -> {
            // Show a generic error message.
        }
    }
}

Constructors

NRError

@JvmOverloads

constructor(errorCode: String = GeneralError, reason: String? = Unknown, description: String? = null, data: Any? = null)

constructor(errorCode: String, description: String?, data: Any? = null)

constructor(error: NRError, data: Any?)

constructor(exception: Throwable)

Types

Companion

object Companion

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

ErrorCode

annotation class ErrorCode

Marks a String value as one of the error code constants defined in the companion object.

ErrorReason

annotation class ErrorReason

Marks a String value as one of the error reason constants defined in the companion object.

Properties

data

var data: Any?

Optional payload attached to the error (for example, a Throwable cause).

description

@SerializedName(value = "error")

var description: String?

Optional human-readable description of the failure.

errorCode

var errorCode: String

Code identifying the type of failure. One of the constants defined in the companion object.

reason

var reason: String?

Optional machine-readable reason that complements errorCode (for example, a transport error category or HTTP status hint).

Functions

data

fun data(data: Any? = null): NRError

Sets NRError.data to data.

equals

open operator override fun equals(other: Any?): Boolean

Two errors are equal when their errorCode, reason, description, and data are equal.

hashCode

open override fun hashCode(): Int

Returns a hash code based on errorCode and reason.

toString

open override fun toString(): String

Returns a description of this error containing errorCode, reason, and description.