Package com.unblu.sdk.core.errortype

Enum Class UnbluClientErrorType

java.lang.Object

java.lang.Enum<UnbluClientErrorType>

com.unblu.sdk.core.errortype.UnbluClientErrorType

All Implemented Interfaces:

Serializable, Comparable<UnbluClientErrorType>, Constable

public enum UnbluClientErrorType
extends Enum<UnbluClientErrorType>

Enum representing different types of errors that can occur within the UnbluClient.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATION	Error thrown if there's an authentication issue while communicating with the Unblu Collaboration Server.
AUTHORIZATION	Error thrown if there's an authorization issue while communicating with the Unblu Collaboration Server.
DISABLED	Error thrown if the mobile SDK module is disabled in the Unblu server configuration.
EXECUTION	Error thrown if a business error occurred during execution.
INTERNAL	General internal error of the UnbluClient.
INVALID_FUNCTION_ARGS	Internal error that prevents the Unblu SDK from communicating with the Unblu Collaboration Server due to invalid function arguments.
INVALID_URL	Error thrown if the URL used to connect to the Unblu Collaboration Server is invalid.
MISSING_API_KEY	Error thrown if the API key doesn't exist on the Unblu Collaboration Server.
SERVER_UNREACHABLE	Error thrown if the Unblu Collaboration Server is unreachable.
UNKNOWN_FUNCTION	Internal error that prevents the Unblu SDK from communicating with the Unblu Collaboration Server.
UNSUPPORTED_VERSION	Error thrown if the version of the mobile SDK isn't compatible with the version of the Unblu Collaboration Server.

Method Summary

Modifier and Type	Method	Description
String	getErrorDescription()	Retrieves the description of the error.
static UnbluClientErrorType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UnbluClientErrorType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INTERNAL

public static final UnbluClientErrorType INTERNAL

General internal error of the UnbluClient.

SERVER_UNREACHABLE

public static final UnbluClientErrorType SERVER_UNREACHABLE

Error thrown if the Unblu Collaboration Server is unreachable.

DISABLED

public static final UnbluClientErrorType DISABLED

Error thrown if the mobile SDK module is disabled in the Unblu server configuration.

UNKNOWN_FUNCTION

public static final UnbluClientErrorType UNKNOWN_FUNCTION

Internal error that prevents the Unblu SDK from communicating with the Unblu Collaboration Server.

INVALID_FUNCTION_ARGS

public static final UnbluClientErrorType INVALID_FUNCTION_ARGS

Internal error that prevents the Unblu SDK from communicating with the Unblu Collaboration Server due to invalid function arguments.

MISSING_API_KEY

public static final UnbluClientErrorType MISSING_API_KEY

Error thrown if the API key doesn't exist on the Unblu Collaboration Server.

UNSUPPORTED_VERSION

public static final UnbluClientErrorType UNSUPPORTED_VERSION

Error thrown if the version of the mobile SDK isn't compatible with the version of the Unblu Collaboration Server.

INVALID_URL

public static final UnbluClientErrorType INVALID_URL

Error thrown if the URL used to connect to the Unblu Collaboration Server is invalid.

AUTHENTICATION

public static final UnbluClientErrorType AUTHENTICATION

Error thrown if there's an authentication issue while communicating with the Unblu Collaboration Server.

AUTHORIZATION

public static final UnbluClientErrorType AUTHORIZATION

Error thrown if there's an authorization issue while communicating with the Unblu Collaboration Server.

EXECUTION

public static final UnbluClientErrorType EXECUTION

Error thrown if a business error occurred during execution.

Method Details

values

public static UnbluClientErrorType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UnbluClientErrorType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getErrorDescription

public String getErrorDescription()

Retrieves the description of the error.

Returns:

The error description.