HID APPROVE SDK  5.13
HID Approve SDK for iOS/macOS
 All Classes Files Functions Variables Enumerations Enumerator Properties Pages
HIDErrors.h File Reference

SDK Error codes. More...

Go to the source code of this file.

Enumerations

enum  HIDErrorCode {
  HIDInternal, HIDNotImplemented, HIDUnsupportedOperation, HIDInvalidArgument,
  HIDKeyGenerationFailure, HIDProtectionPolicyFailure, HIDSecureDataFailure, HIDUnsupportedVersion,
  HIDInvalidContainer, HIDInexplicitContainer, HIDAuthentication =100, HIDInvalidPassword,
  HIDCredentialsExpired, HIDPasswordExpired, HIDPasswordNotYetUpdatable, HIDPasswordRequired,
  HIDLostCredentials, HIDInvalidChallengeTooLong, HIDInvalidChallengeBadFormat, HIDPasswordCancelled,
  HIDUnsupportedDevice =200, HIDUnsafeDevice, HIDFingerprintNotEnrolled, HIDUserCancelled,
  HIDFingerprintAuthenticationRequired, HIDUnsupportedOperationMode, HIDServerAuthentication =300, HIDServerVersion,
  HIDServerProtocol, HIDRemote, HIDServerUnsupportedOperation, HIDServerOperationFailed,
  HIDTransactionExpired =1000, HIDTransactionContainerInvalid
}
 SDK error codes. More...
 

Variables

NSString *const HIDErrorDomain
 The domain of errors returned by the sdk.
 

Detailed Description

SDK Error codes.

Enumeration Type Documentation

SDK error codes.

Enumeration HIDErrorCodes

Enumerator
HIDInternal 

(0) An unexpected error occurred.

HIDNotImplemented 

(1) The method is not implemented.

HIDUnsupportedOperation 

(2) The operation is not supported by the object.

HIDInvalidArgument 

(3) An invalid argument was encountered.

HIDKeyGenerationFailure 

(4) Unable to generate internal credential.

HIDProtectionPolicyFailure 

(5) Unable to create or locate internal protection policy.

HIDSecureDataFailure 

(6) Unable to create or locate internal credential data.

HIDUnsupportedVersion 

(7) Container version is not supported

HIDInvalidContainer 

(8) An invalid container

HIDInexplicitContainer 

(9) Container is ambigious and cannot be explicitly determined

HIDAuthentication 

(100) Authentication failed.

HIDInvalidPassword 

(101) The password fails policy requirements.

HIDCredentialsExpired 

(102) The credentials used to sign the transaction have expired.

HIDPasswordExpired 

(103) The password has expired and requires a change of password.

HIDPasswordNotYetUpdatable 

(104) The password cannot be changed yet.

HIDPasswordRequired 

(105) The required password was not provided.

HIDLostCredentials 

(106) The provisioning key securing the transaction has been wiped.

HIDInvalidChallengeTooLong 

(107) The challenge is too long with respect to the OTP configuration.

HIDInvalidChallengeBadFormat 

(108) The challenge does not have the format expected by the OTP configuration.

HIDPasswordCancelled 

(109) The password event has been cancelled by the user.

HIDUnsupportedDevice 

(200) The device configuration is not supported.

HIDUnsafeDevice 

(201) The device is not safe enough to store sensitive secrets.

HIDFingerprintNotEnrolled 

(202) Fingerprints have not been enrolled.

HIDUserCancelled 

(203) The user has cancelled the operation.

HIDFingerprintAuthenticationRequired 

(204) Authentication with fingerprint is required to perform the operation.

HIDUnsupportedOperationMode 

(205) Mode operation required by the server is not supported by the device.

HIDServerAuthentication 

(300) Authentication to the server failed.

HIDServerVersion 

(301) The server protocol version is not supported by the client or does not support client operation.

HIDServerProtocol 

(302) An unexpected failure has occurred in the implementation layer.

HIDRemote 

(303) Execution of a remote method call failed.

HIDServerUnsupportedOperation 

(304) Operation not supported by the server.

HIDServerOperationFailed 

(305) The server operation failed.

HIDTransactionExpired 

(1000) The transaction has expired.

HIDTransactionContainerInvalid 

(1001) The transaction id refers to a container that does not exist. It may happen if the container is deleted locally without notifying the server.