TMGError

public enum TMGError : LocalizedError

An error object that is returned when there is a problem in the process.

Version

Version 1.0

Since

Since 1.0

  • This is returned when the token provided is not bound with the device.

    Declaration

    Swift

    case tokenNotBound

  • This is returned when the token provided is in the pending state.

    Declaration

    Swift

    case tokenPending

  • This is returned when the token provided is in a declined state.

    Declaration

    Swift

    case tokenDeclined

  • This is returned when the token provided is already bounded with the device or pending activation.

    Since

    Since 3.0

    Declaration

    Swift

    case tokenAlreadyBound

  • This is returned when some of the TMGClientConfiguration parameters are invalid.

    Declaration

    Swift

    case invalidConfigParams

  • This is returned when some of the mandatory parameters on this API are invalid.

    Declaration

    Swift

    case invalidRequiredParams

  • This is returned when the IDV method provided is invalid.

    Declaration

    Swift

    case invalidIdvMethod

  • The OTP provided is not in the correct format. The OTP should also not be null, empty or more than 8 digits.

    Declaration

    Swift

    case invalidOTPMessage

  • This is returned when the issuer authentication is required. Use the IDVSession.selectIDVMethod(...) function.

    Since

    Since 3.0

    Declaration

    Swift

    case issuerAuthenticationRequired

  • This is returned when the biometrics are not enrolled on the device.

    Declaration

    Swift

    case biometricNotSupported

  • This is returned when the end user authentication is failing. Check the reason message for the error.

    Since

    Since 1.0.1

    Declaration

    Swift

    case authenticationFailure(reason: String)

  • This is returned when the end user changes the biometrics to be used for the authentication. For example, the end user changes the biometrics (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

  • This is returned when an internal error occurs. Check the additional message for the error.

    Since

    Since 1.0.1

    Declaration

    Swift

    case internalError(additionalMessage: String)

  • This is returned when the device environment is potentially unsafe. Check the error by looking at the obfuscated error code.

    Since

    Since 1.0.1

    Declaration

    Swift

    case deviceEnvironmentUnsafe(code: Int)

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

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverIsNotAccessible

  • This is 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

  • This is returned when there is a server error. Check the the error by looking at the HTTP status code and the additional message; if any.

    Since

    Since 1.0.1

    Declaration

    Swift

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

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

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorTooManyRequest

  • This is returned when there is an error when performing the crypto operation on the server.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorCryptoError

  • This is returned when the token state is invalid.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorInvalidTokenState

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

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorIdvNotAvailable

  • This is returned when the session cannot be found.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorNoSessionFound

  • This is returned when the end user enters an incorrect OTP.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorWrongOTP

  • This is returned when the end user enters an expired OTP.

    Since

    Since 1.0.1

    Declaration

    Swift

    case serverErrorExpiredOTP

  • This is 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 }