TMGError

public enum TMGError : LocalizedError

Error object that returned when there’s something wrong in the process.

Version

Version 1.0

Since

Since 1.0

  • Returned when the provided token is not bounded with the device.

    Declaration

    Swift

    case tokenNotBound

  • Returned when the provided token is in unbound state.

    Declaration

    Swift

    case tokenUnbound

  • Returned when the provided token is in pending state.

    Declaration

    Swift

    case tokenPending

  • Returned when the provided token is in declined state.

    Declaration

    Swift

    case tokenDeclined

  • Returned when the provided token is in active state.

    Since

    Since 1.0.1

    Declaration

    Swift

    case tokenActive

  • Returned when some of the TMGClientConfiguration parameter is invalid.

    Declaration

    Swift

    case invalidConfigParams

  • Returned when some of the mandatory parameters on this API is invalid.

    Declaration

    Swift

    case invalidRequiredParams

  • Returned when the provided IDV method is invalid.

    Declaration

    Swift

    case invalidIdvMethod

  • Returned when the provided OTP is invalid.

    Declaration

    Swift

    case invalidOTPMessage

  • Returned when the issuer authentication is required. Use PendingBindingSession.submitIdvMethod(...).

    Declaration

    Swift

    case issuerAuthenticationRequired

  • Returned when the biometric is not enrolled on the device.

    Declaration

    Swift

    case biometricNotSupported

  • Returned when the user authentication is failing. Check the reason message for the error.

    Since

    Since 1.0.1

    Declaration

    Swift

    case authenticationFailure(reason: String)

  • Returned when the end user changed the biometric to be used for authentication. For example, the end user changed the biometric (faceId or fingerprint) on the device. When this error is returned, the cryptographic key pair will not be accessible anymore, hence all the tokens will be unbound automatically.

    Since

    Since 2.1.0

    Declaration

    Swift

    case authenticationKeyInvalidated

  • Returned when there’s an internal error. Check additional message for the error.

    Since

    Since 1.0.1

    Declaration

    Swift

    case internalError(additionalMessage: String)

  • Returned when the device environment is potentially unsafe. Check the obfuscated error code for the error.

    Since

    Since 1.0.1

    Declaration

    Swift

    case deviceEnvironmentUnsafe(code: Int)

  • Returned when the server is not accesible due to network connection issue.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverIsNotAccessible

  • Returned when the server is unable to handle the current request due to a temporary overloading or maintenance of the server.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverRetryable

  • Returned when there’s a server error. Check the HTTP status code for the error and the additional message; if any.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverError(httpStatusCode: Int, additionalMessage: String? = nil)

  • Returned when there are too many requests on the server. Please try it again later.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorTooManyRequest

  • Returned when there’s an error when performing crypto operation on the server.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorCryptoError

  • Returned when the token state is invalid.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorInvalidTokenState

  • Returned when the end user selects an IDV method that is not available.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorIdvNotAvailable

  • Returned when the session cannot be found.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorNoSessionFound

  • Returned when the end user key in the wrong otp.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorWrongOTP

  • Returned when the end user enters an expired OTP.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorExpiredOTP

  • Returned when the end user exceeds the number of retries allowed.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorRetryLimitExceeded

  • Description of the TMGError.

    Declaration

    Swift

    public var description: String { get }

  • Returned the error description.

    Since

    Since 1.0.1

    Declaration

    Swift

    public var errorDescription: String? { get }