ErrorCode
Enum representing different error codes.
This enumeration describes the various error codes exposed by the SDK.
Syntax:
enum ErrorCode : Enum<ErrorCode>
Value | Description |
---|---|
NOT_INITIALIZED | Indicates the SDK has not been initialized/started. |
ALREADY_INITIALIZED | Indicates the SDK is already started, but another attempt has been made. |
NOT_REGISTERED | Indicates attempted access to a feature before registering a user. |
FEATURE_NOT_SUPPORTED | Indicates attempted access to a feature that is not enabled within the Webex Connect app configuration. |
INVALID_PARAMETER_VALUE | It indicates that a required parameter is missing or an invalid value has been passed. |
PERMISSION_NOT_GRANTED | Indicates that permission required to process operation has not been granted. |
ALREADY_REGISTERED | Indicates a user is already registered but another registration attempt has been made. |
PUSH_REGISTRATION_FAILED | Indicates that the SDK failed to register for push notifications. |
REST_FAILURE | It indicates that a REST API call to the Webex Connect platform has failed. Used exclusively with ICRestException that exposes the underlying error. |
NOT_CONNECTED | Indicates an In-App Messaging operation has been attempted while no active connection exists. |
CONNECTION_FAILURE | Indicates that an In-App Messaging connection error occurred. |
PUBLISH_FAILED | Indicates that the In-App Message publication failed. |
SUBSCRIBE_FAILED | Indicates that the topic subscription operation failed. |
UNSUBSCRIBE_FAILED | Indicates that the operation to unsubscribe from a topic failed. |
TOKEN_INVALID | Indicates the Security Token is invalid. |
TOKEN_REQUIRED | It indicates that a Security Token is required. |
TOKEN_EXPIRED | It indicates that a Security Token has expired. |
SDK_VERSION_NOT_SUPPORTED | Indicates that SDK not supported. |
UNKNOWN | Indicates that an unknown error has occurred. |
Functions
valueOf()
This method 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.)
Syntax:fun valueOf(value: String): ErrorCode
Throws
Throws | Description |
---|---|
IllegalArgumentException | if this enum type has no constant with the specified name |
values()
This method returns an array containing the constants of this enum type, in the order they're declared.
Syntax: fun values(): Array<ErrorCode>
Updated about 1 month ago