com.squareup.sdk.reader.checkout

Enum CheckoutErrorCode

java.lang.Object

java.lang.Enum<CheckoutErrorCode>

com.squareup.sdk.reader.checkout.CheckoutErrorCode

All Implemented Interfaces:

ErrorCode, java.io.Serializable, java.lang.Comparable<CheckoutErrorCode>

public enum CheckoutErrorCode
extends java.lang.Enum<CheckoutErrorCode>
implements ErrorCode

Possible error codes that can be returned as a result of a call to CheckoutManager.startCheckoutActivity(Context, CheckoutParameters).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELED The checkout flow was canceled.
SDK_NOT_AUTHORIZED Reader SDK is not currently authorized.
USAGE_ERROR CheckoutManager.startCheckoutActivity(Context, CheckoutParameters) was used in an unexpected or unsupported way.

Method Summary

Modifier and Type	Method and Description
boolean	isUsageError() Returns true if the error is a usage error, false otherwise.
static CheckoutErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CheckoutErrorCode[]	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

CANCELED

public static final CheckoutErrorCode CANCELED

The checkout flow was canceled.

SDK_NOT_AUTHORIZED

public static final CheckoutErrorCode SDK_NOT_AUTHORIZED

Reader SDK is not currently authorized.

USAGE_ERROR

public static final CheckoutErrorCode USAGE_ERROR

CheckoutManager.startCheckoutActivity(Context, CheckoutParameters) was used in an unexpected or unsupported way. See ResultError.getDebugCode() and ResultError.getDebugMessage() for more information.

Method Detail

values

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

Returns:

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

valueOf

public static CheckoutErrorCode 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

isUsageError

public boolean isUsageError()

Description copied from interface: ErrorCode

Returns true if the error is a usage error, false otherwise.

Useful for writing shared handling of debug codes and messages across Reader SDK operations.

Specified by:

isUsageError in interface ErrorCode