Error (app 3.0.0-prerelease-1 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - com.wepay.android.models.Error

All Implemented Interfaces:

java.io.Serializable
```
public class Error
extends java.lang.Exception
```
The Class Error contains information about an error that occurs in the sdk.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ERROR_CATEGORY_API` The constant string representing the error category API Error.
`static java.lang.String`	`ERROR_CATEGORY_CARD_READER` The constant string representing the error category Card reader Error.
`static java.lang.String`	`ERROR_CATEGORY_SDK` The constant string representing the error category SDK Error.
`static java.lang.String`	`ERROR_DOMAIN_API` The constant ERROR_DOMAIN_API
`static java.lang.String`	`ERROR_DOMAIN_SDK` The constant ERROR_DOMAIN_SDK

Constructor Summary

Constructors
Constructor and Description
`Error(java.lang.Integer errorCode, java.lang.String errorDomain, java.lang.String errorCategory, java.lang.String errorDescription)` \internal Instantiates a new error.
`Error(java.lang.Integer errorCode, java.lang.String errorDomain, java.lang.String errorCategory, java.lang.String errorDescription, java.lang.Exception innerException)` \internal Instantiates a new error.
`Error(org.json.JSONObject errorResponse, java.lang.Throwable throwable)` \internal Instantiates a new error from a WePay server api response.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`static Error`	`getCardBlockedError()` \internal Instantiates card blocked error.
`static Error`	`getCardDeclinedByIssuerError()` \internal Instantiates card declined by issuer error.
`static Error`	`getCardNotSupportedError()` \internal Instantiates a card not supported error.
`static Error`	`getCardReaderBatteryTooLowError()` \internal Instantiates a card reader battery too low error.
`static Error`	`getCardReaderErrorWithMessage(java.lang.String errorMessage)` \internal Instantiates a generic card reader error with the provided message.
`static Error`	`getCardReaderGeneralError()` \internal Instantiates a card reader general error.
`static Error`	`getCardReaderGeneralErrorWithMessage(java.lang.String errorDescription)`
`static Error`	`getCardReaderInitializationError()` \internal Instantiates a card reader initialization error.
`static Error`	`getCardReaderNotConnectedError()` \internal Instantiates a card reader not connected error.
`static Error`	`getCardReaderStatusError(java.lang.String message)` \internal Instantiates a card reader status error.
`static Error`	`getCardReaderTimeoutError()` \internal Instantiates a card reader timeout error.
`static Error`	`getCardReaderUnableToConnectError()` \internal Instantiates an unable to connect to card reader error.
`static Error`	`getCardReaderUnknownError()` \internal Instantiates a card reader unknown error.
`static Error`	`getDeclinedByCardError()` \internal Instantiates declined by card error.
`static Error`	`getEmvTransactionErrorWithMessage(java.lang.String errorMessage)` \internal Instantiates an EMV transaction error with the provided message.
`java.lang.String`	`getErrorCategory()` Gets the error category.
`java.lang.Integer`	`getErrorCode()` Gets the error code.
`java.lang.String`	`getErrorDescription()` Gets the error description.
`java.lang.String`	`getErrorDomain()` Gets the error domain.
`static Error`	`getErrorWithCardReaderResponseData(java.util.Map<com.roam.roamreaderunifiedapi.constants.Parameter,java.lang.Object> data)`
`static Error`	`getFailedToGetBatteryLevelError()` \internal Instantiates failed to get battery level error.
`java.lang.Exception`	`getInnerException()` Gets the inner exception.
`static Error`	`getInvalidApplicationIdError()` \internal Instantiates invalid application id error.
`static Error`	`getInvalidCardDataError()` \internal Instantiates a invalid card data error.
`static Error`	`getInvalidCardReaderSelectionError()` \internal Instantiates a card reader selection error.
`static Error`	`getInvalidSignatureImageError(java.lang.Exception e)` \internal Instantiates a invalid signature image error.
`static Error`	`getInvalidTransactionAccountIDError()` \internal Instantiates invalid transaction account ID error.
`static Error`	`getInvalidTransactionAmountError()` \internal Instantiates invalid transaction amount error.
`static Error`	`getInvalidTransactionCurrencyCodeError()` \internal Instantiates invalid transaction currency code error.
`static Error`	`getIssuerUnreachableError()` \internal Instantiates issuer unreachable error.
`java.lang.String`	`getMessage()`
`static Error`	`getNameNotFoundError()` \internal Instantiates a name not found error.
`static Error`	`getNoDataReturnedError()` \internal Instantiates a no data returned error.
`static Error`	`getPaymentMethodCannotBeTokenizedError()` \internal Instantiates payment method cannot be tokenized error.
`static Error`	`getTransactionInfoNotProvidedError()` \internal Instantiates transaction info not provided error.
`int`	`hashCode()`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ERROR_DOMAIN_API
```
public static final java.lang.String ERROR_DOMAIN_API
```
    The constant ERROR_DOMAIN_API
    
    See Also:
    
    Constant Field Values
  - ERROR_DOMAIN_SDK
```
public static final java.lang.String ERROR_DOMAIN_SDK
```
    The constant ERROR_DOMAIN_SDK
    
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_CARD_READER
```
public static final java.lang.String ERROR_CATEGORY_CARD_READER
```
    The constant string representing the error category Card reader Error.
    
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_API
```
public static final java.lang.String ERROR_CATEGORY_API
```
    The constant string representing the error category API Error.
    
    See Also:
    
    Constant Field Values
  - ERROR_CATEGORY_SDK
```
public static final java.lang.String ERROR_CATEGORY_SDK
```
    The constant string representing the error category SDK Error.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Error
```
public Error(java.lang.Integer errorCode,
             java.lang.String errorDomain,
             java.lang.String errorCategory,
             java.lang.String errorDescription,
             java.lang.Exception innerException)
```
    \internal Instantiates a new error. Use this constructor when an inner exception is available.
    
    Parameters:
    
    errorCode - the error code
    
    errorDomain - the error domain
    
    errorCategory - the error category
    
    errorDescription - the error description
    
    innerException - the inner exception that caused the error
  - Error
```
public Error(java.lang.Integer errorCode,
             java.lang.String errorDomain,
             java.lang.String errorCategory,
             java.lang.String errorDescription)
```
    \internal Instantiates a new error. Use this constructor when there is no inner exception.
    
    Parameters:
    
    errorCode - the error code
    
    errorDomain - the error domain
    
    errorCategory - the error category
    
    errorDescription - the error description
  - Error
```
public Error(org.json.JSONObject errorResponse,
             java.lang.Throwable throwable)
```
    \internal Instantiates a new error from a WePay server api response.
    
    Parameters:
    
    errorResponse - the error response from the WePay server
    
    throwable - the throwable generated by the api call
- Method Detail
  - getErrorCategory
```
public java.lang.String getErrorCategory()
```
    Gets the error category.
    
    Returns:
    
    the error category
  - getErrorDomain
```
public java.lang.String getErrorDomain()
```
    Gets the error domain.
    
    Returns:
    
    the error domain
  - getErrorDescription
```
public java.lang.String getErrorDescription()
```
    Gets the error description.
    
    Returns:
    
    the error description
  - getErrorCode
```
public java.lang.Integer getErrorCode()
```
    Gets the error code.
    
    Returns:
    
    the error code
  - getInnerException
```
public java.lang.Exception getInnerException()
```
    Gets the inner exception.
    
    Returns:
    
    the inner exception
  - getMessage
```
public java.lang.String getMessage()
```
    Overrides:
    
    getMessage in class java.lang.Throwable
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Throwable
  - getCardReaderInitializationError
```
public static Error getCardReaderInitializationError()
```
    \internal Instantiates a card reader initialization error.
    
    Returns:
    
    the card reader timeout error
  - getCardReaderTimeoutError
```
public static Error getCardReaderTimeoutError()
```
    \internal Instantiates a card reader timeout error.
    
    Returns:
    
    the card reader timeout error
  - getCardReaderErrorWithMessage
```
public static Error getCardReaderErrorWithMessage(java.lang.String errorMessage)
```
    \internal Instantiates a generic card reader error with the provided message.
    
    Parameters:
    
    errorMessage - the message used in the error
    
    Returns:
    
    the card reader error
  - getInvalidCardDataError
```
public static Error getInvalidCardDataError()
```
    \internal Instantiates a invalid card data error.
    
    Returns:
    
    the invalid card data error
  - getCardNotSupportedError
```
public static Error getCardNotSupportedError()
```
    \internal Instantiates a card not supported error.
    
    Returns:
    
    the card not supported error
  - getEmvTransactionErrorWithMessage
```
public static Error getEmvTransactionErrorWithMessage(java.lang.String errorMessage)
```
    \internal Instantiates an EMV transaction error with the provided message.
    
    Parameters:
    
    errorMessage - the message used in the error
    
    Returns:
    
    the EMV transaction error
  - getInvalidApplicationIdError
```
public static Error getInvalidApplicationIdError()
```
    \internal Instantiates invalid application id error.
    
    Returns:
    
    the invalid application id error
  - getDeclinedByCardError
```
public static Error getDeclinedByCardError()
```
    \internal Instantiates declined by card error.
    
    Returns:
    
    the declined by card error
  - getCardBlockedError
```
public static Error getCardBlockedError()
```
    \internal Instantiates card blocked error.
    
    Returns:
    
    the card blocked error
  - getIssuerUnreachableError
```
public static Error getIssuerUnreachableError()
```
    \internal Instantiates issuer unreachable error.
    
    Returns:
    
    the issuer unreachable error
  - getNoDataReturnedError
```
public static Error getNoDataReturnedError()
```
    \internal Instantiates a no data returned error.
    
    Returns:
    
    the no data returned error
  - getCardDeclinedByIssuerError
```
public static Error getCardDeclinedByIssuerError()
```
    \internal Instantiates card declined by issuer error.
    
    Returns:
    
    the card declined by issuer error
  - getInvalidTransactionAmountError
```
public static Error getInvalidTransactionAmountError()
```
    \internal Instantiates invalid transaction amount error.
    
    Returns:
    
    the invalid transaction amount error
  - getInvalidTransactionCurrencyCodeError
```
public static Error getInvalidTransactionCurrencyCodeError()
```
    \internal Instantiates invalid transaction currency code error.
    
    Returns:
    
    the invalid transaction currency code error
  - getInvalidTransactionAccountIDError
```
public static Error getInvalidTransactionAccountIDError()
```
    \internal Instantiates invalid transaction account ID error.
    
    Returns:
    
    the invalid transaction account ID error
  - getTransactionInfoNotProvidedError
```
public static Error getTransactionInfoNotProvidedError()
```
    \internal Instantiates transaction info not provided error.
    
    Returns:
    
    the transaction info not provided error
  - getPaymentMethodCannotBeTokenizedError
```
public static Error getPaymentMethodCannotBeTokenizedError()
```
    \internal Instantiates payment method cannot be tokenized error.
    
    Returns:
    
    the payment method cannot be tokenized error
  - getFailedToGetBatteryLevelError
```
public static Error getFailedToGetBatteryLevelError()
```
    \internal Instantiates failed to get battery level error.
    
    Returns:
    
    the failed to get battery level error
  - getCardReaderNotConnectedError
```
public static Error getCardReaderNotConnectedError()
```
    \internal Instantiates a card reader not connected error.
    
    Returns:
    
    the card reader not connected error
  - getCardReaderGeneralError
```
public static Error getCardReaderGeneralError()
```
    \internal Instantiates a card reader general error.
    
    Returns:
    
    the card reader general error
  - getCardReaderUnknownError
```
public static Error getCardReaderUnknownError()
```
    \internal Instantiates a card reader unknown error.
    
    Returns:
    
    the card reader unknown error
  - getCardReaderStatusError
```
public static Error getCardReaderStatusError(java.lang.String message)
```
    \internal Instantiates a card reader status error.
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the card reader status error
  - getInvalidSignatureImageError
```
public static Error getInvalidSignatureImageError(java.lang.Exception e)
```
    \internal Instantiates a invalid signature image error.
    
    Parameters:
    
    e - the exception generated during image validation
    
    Returns:
    
    the invalid signature image error
  - getNameNotFoundError
```
public static Error getNameNotFoundError()
```
    \internal Instantiates a name not found error.
    
    Returns:
    
    the name not found error
  - getInvalidCardReaderSelectionError
```
public static Error getInvalidCardReaderSelectionError()
```
    \internal Instantiates a card reader selection error.
    
    Returns:
    
    the card reader selection error
  - getCardReaderBatteryTooLowError
```
public static Error getCardReaderBatteryTooLowError()
```
    \internal Instantiates a card reader battery too low error.
    
    Returns:
    
    the card reader battery too low error
  - getCardReaderUnableToConnectError
```
public static Error getCardReaderUnableToConnectError()
```
    \internal Instantiates an unable to connect to card reader error.
    
    Returns:
    
    the unable to connect to card reader error
  - getErrorWithCardReaderResponseData
```
public static Error getErrorWithCardReaderResponseData(java.util.Map<com.roam.roamreaderunifiedapi.constants.Parameter,java.lang.Object> data)
```
  - getCardReaderGeneralErrorWithMessage
```
public static Error getCardReaderGeneralErrorWithMessage(java.lang.String errorDescription)
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object

Class Error

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Throwable

Methods inherited from class java.lang.Object

Field Detail

ERROR_DOMAIN_API

ERROR_DOMAIN_SDK

ERROR_CATEGORY_CARD_READER

ERROR_CATEGORY_API

ERROR_CATEGORY_SDK

Constructor Detail

Error

Error

Error

Method Detail

getErrorCategory

getErrorDomain

getErrorDescription

getErrorCode

getInnerException

getMessage

toString

getCardReaderInitializationError

getCardReaderTimeoutError

getCardReaderErrorWithMessage

getInvalidCardDataError

getCardNotSupportedError

getEmvTransactionErrorWithMessage

getInvalidApplicationIdError

getDeclinedByCardError

getCardBlockedError

getIssuerUnreachableError

getNoDataReturnedError

getCardDeclinedByIssuerError

getInvalidTransactionAmountError

getInvalidTransactionCurrencyCodeError

getInvalidTransactionAccountIDError

getTransactionInfoNotProvidedError

getPaymentMethodCannotBeTokenizedError

getFailedToGetBatteryLevelError

getCardReaderNotConnectedError

getCardReaderGeneralError

getCardReaderUnknownError

getCardReaderStatusError

getInvalidSignatureImageError

getNameNotFoundError

getInvalidCardReaderSelectionError

getCardReaderBatteryTooLowError

getCardReaderUnableToConnectError

getErrorWithCardReaderResponseData

getCardReaderGeneralErrorWithMessage

hashCode

equals