com.apple.android.sdk.authentication

Enum TokenError

java.lang.Object

java.lang.Enum<TokenError>

com.apple.android.sdk.authentication.TokenError

All Implemented Interfaces:

Serializable, Comparable<TokenError>

public enum TokenError
extends Enum<TokenError>

Enum indicating the possible authentication error values.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NO_SUBSCRIPTION indicates error due to user not having a subscription.
SUBSCRIPTION_EXPIRED indicates error due to user's subscription expired.
TOKEN_FETCH_ERROR indicates error in fetching music token, say due to developer token invalid/exipred.
UNKNOWN indicates an unknown error in fetching music token.
USER_CANCELLED indicates error due to user cancelling the authentication flow.

Method Summary

Modifier and Type	Method and Description
int	getErrorCode()
static TokenError	getErrorFromValue(int tokenError)
static TokenError	valueOf(String name) Returns the enum constant of this type with the specified name.
static TokenError[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_SUBSCRIPTION

public static final TokenError NO_SUBSCRIPTION

indicates error due to user not having a subscription.

SUBSCRIPTION_EXPIRED

public static final TokenError SUBSCRIPTION_EXPIRED

indicates error due to user's subscription expired.

TOKEN_FETCH_ERROR

public static final TokenError TOKEN_FETCH_ERROR

indicates error in fetching music token, say due to developer token invalid/exipred.

UNKNOWN

public static final TokenError UNKNOWN

indicates an unknown error in fetching music token.

USER_CANCELLED

public static final TokenError USER_CANCELLED

indicates error due to user cancelling the authentication flow.

Method Detail

getErrorCode

public int getErrorCode()

getErrorFromValue

public static TokenError getErrorFromValue(int tokenError)

valueOf

public static TokenError valueOf(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:

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

NullPointerException - if the argument is null

values

public static TokenError[] 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 (TokenError c : TokenError.values())
    System.out.println(c);

Returns:

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