Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
Push & In-App SDKs
FAQsWebsite

ErrorCode

Enum representing different error codes.

Suggest Edits

This enumeration describes the various error codes exposed by the SDK.

Syntax:

enum ErrorCode : Enum<ErrorCode>

ValueDescription
NOT_INITIALIZEDIndicates the SDK has not been initialized/started.
ALREADY_INITIALIZEDIndicates the SDK is already started, but another attempt has been made.
NOT_REGISTEREDIndicates attempted access to a feature before registering a user.
FEATURE_NOT_SUPPORTEDIndicates attempted access to a feature that is not enabled within the Webex Connect app configuration.
INVALID_PARAMETER_VALUEIt indicates that a required parameter is missing or an invalid value has been passed.
PERMISSION_NOT_GRANTEDIndicates that permission required to process operation has not been granted.
ALREADY_REGISTEREDIndicates a user is already registered but another registration attempt has been made.
PUSH_REGISTRATION_FAILEDIndicates that the SDK failed to register for push notifications.
REST_FAILUREIt indicates that a REST API call to the Webex Connect platform has failed. Used exclusively with ICRestException that exposes the underlying error.
NOT_CONNECTEDIndicates an In-App Messaging operation has been attempted while no active connection exists.
CONNECTION_FAILUREIndicates that an In-App Messaging connection error occurred.
PUBLISH_FAILEDIndicates that the In-App Message publication failed.
SUBSCRIBE_FAILEDIndicates that the topic subscription operation failed.
UNSUBSCRIBE_FAILEDIndicates that the operation to unsubscribe from a topic failed.
TOKEN_INVALIDIndicates the Security Token is invalid.
TOKEN_REQUIREDIt indicates that a Security Token is required.
TOKEN_EXPIREDIt indicates that a Security Token has expired.
SDK_VERSION_NOT_SUPPORTEDIndicates that SDK not supported.
UNKNOWNIndicates that an unknown error has occurred.

Functions

MethodReturn Type
valueOfErrorCode
valuesArray

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

ThrowsDescription
IllegalArgumentExceptionif 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 8 days ago