com.proxama.tappoint.error

Enum ApiError

java.lang.Object

java.lang.Enum<ApiError>

com.proxama.tappoint.error.ApiError

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ApiError>

public enum ApiError
extends java.lang.Enum<ApiError>

Represents an error that can occur whilst using the TapPoint SDK.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_AUTHENTICATED The application has already been authenticated with a different application name.
AUTHENTICATION_ALREADY_IN_PROGRESS An attempt to authenticate has been made while a previous attempt is still in progress.
CONNECTION_TIMEOUT The server connection timed out.
INVALID_SERVER_RESPONSE The server has returned an invalid response to a request made by the SDK.
NO_INTERNET There is no available network connection.
NOT_AUTHENTICATED The API call is not correctly authenticated.
SYNC_ALREADY_IN_PROGRESS An attempt to synchronise has been made while a previous attempt is still in progress.
UNEXPECTED_INTERNAL_ERROR An internal error has occurred.
UNKNOWN_APP_NAME The application name passed to the API is not known by TapPoint.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getErrorMessage() Gets the error message.
static ApiError	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ApiError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_INTERNET

public static final ApiError NO_INTERNET

There is no available network connection.

CONNECTION_TIMEOUT

public static final ApiError CONNECTION_TIMEOUT

The server connection timed out.

UNKNOWN_APP_NAME

public static final ApiError UNKNOWN_APP_NAME

The application name passed to the API is not known by TapPoint.

NOT_AUTHENTICATED

public static final ApiError NOT_AUTHENTICATED

The API call is not correctly authenticated.

ALREADY_AUTHENTICATED

public static final ApiError ALREADY_AUTHENTICATED

The application has already been authenticated with a different application name.

AUTHENTICATION_ALREADY_IN_PROGRESS

public static final ApiError AUTHENTICATION_ALREADY_IN_PROGRESS

An attempt to authenticate has been made while a previous attempt is still in progress.

INVALID_SERVER_RESPONSE

public static final ApiError INVALID_SERVER_RESPONSE

The server has returned an invalid response to a request made by the SDK.

SYNC_ALREADY_IN_PROGRESS

public static final ApiError SYNC_ALREADY_IN_PROGRESS

An attempt to synchronise has been made while a previous attempt is still in progress.

UNEXPECTED_INTERNAL_ERROR

public static final ApiError UNEXPECTED_INTERNAL_ERROR

An internal error has occurred.

Method Detail

values

public static ApiError[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ApiError c : ApiError.values())
    System.out.println(c);

Returns:

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

valueOf

public static ApiError valueOf(java.lang.String name)

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.)

Parameters:

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

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getErrorMessage

public java.lang.String getErrorMessage()

Gets the error message.

Returns:

the error message.