Mobile Payments SDK Android Technical Reference/com.squareup.sdk.mobilepayments.core/Result/Failure

Failure

class Failure<S, C>(val errorCode: C, val errorMessage: String, val details: List<ErrorDetails> = emptyList(), val debugCode: String, val debugMessage: String) : Result<S, C>

Failed operation result, containing detailed description of the cause.

Parameters

errorCode

Error code of an unsuccessful operation. Use this error code to appropriately handle the failure.

errorMessage

Error message with the cause of failure intended for end users.

details

More detailed descriptions of the error(s) causing the failure, if available. In many cases these are the actual errors returned from a server call. It is possible for a failure to happen without more detail that provided by the other fields, and this will be an empty list in such cases. (For example, error code NOT_AUTHORIZED has no additional details, the developer simply needs to call AuthorizationManager.authorize() before using the failing Mobile Payments SDK method).

debugCode

More detailed "debug" error code for troubleshooting the failure. Intended for developers only.

debugMessage

More detailed error message containing additional debug information related to the possible cause of the failure. Intended for developers only.

Constructors

constructor(errorCode: C, errorMessage: String, details: List<ErrorDetails> = emptyList(), debugCode: String, debugMessage: String)

Properties

val debugCode: String

val debugMessage: String

val details: List<ErrorDetails>

val errorCode: C

val errorMessage: String

Functions

fun debugCode(): String

More detailed "debug" error code for troubleshooting the failure

fun debugMessage(): String

Human-readable message containing additional debug information related to the possible cause of the failure.

fun details(): List<ErrorDetails>

More detailed descriptions of the error(s) causing the failure, if available. In many cases these are the actual errors returned from a server call. It is possible for a failure to happen without more detail that provided by the other fields, and this will be an empty list in such cases. (For example, error code NOT_AUTHORIZED has no additional details, the developer simply needs to call AuthorizationManager.authorize() before using the failing Mobile Payments SDK method).

fun errorCode(): C

Error code of an unsuccessful operation

fun errorMessage(): String

Displayable message that summarizes the possible cause of the failure.

fun isFailure(): Boolean

true if the operation resulted in a failure. For details see errorCode, errorMessage, debugCode and debugMessage.

fun isSuccess(): Boolean

true if the operation was successful. See value for the result.

fun value(): S

Result of a successful operation.