Package com.batch.android

Enum Class FailReason

java.lang.Object

java.lang.Enum<FailReason>

com.batch.android.FailReason

All Implemented Interfaces:

Serializable, Comparable<FailReason>, java.lang.constant.Constable

public enum FailReason
extends Enum<FailReason>

Reason for Batch failure

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
DEACTIVATED_API_KEY	Your API key has been deactivated
INVALID_API_KEY	Your API key is invalid
NETWORK_ERROR	Network is not available or not responding
SDK_OPTED_OUT	Batch has globally been opted out from: network calls are not allowed
UNEXPECTED_ERROR	An unexpected error occured, a future retry can succeed

Method Summary

Modifier and Type	Method	Description
static FailReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FailReason[]	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

NETWORK_ERROR

public static final FailReason NETWORK_ERROR

Network is not available or not responding

INVALID_API_KEY

public static final FailReason INVALID_API_KEY

Your API key is invalid

DEACTIVATED_API_KEY

public static final FailReason DEACTIVATED_API_KEY

Your API key has been deactivated

UNEXPECTED_ERROR

public static final FailReason UNEXPECTED_ERROR

An unexpected error occured, a future retry can succeed

SDK_OPTED_OUT

public static final FailReason SDK_OPTED_OUT

Batch has globally been opted out from: network calls are not allowed

Method Details

values

public static FailReason[] 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 FailReason 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