EMSystemBioFingerprintContainer Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | EMSystemBioFingerprintContainer.h |
Overview
The biometric fingerprint authentication container.
Warning: Do not subclass this interface.
+ containerWithBioFingerprintAuthService:
Designated constructor. Returns the EMSystemBioFingerprintContainer object created using the EMSystemBioFingerprintAuthService
+ (EMSystemBioFingerprintContainer *)containerWithBioFingerprintAuthService:(EMSystemBioFingerprintAuthService *)serviceParameters
service |
the instance of EMSystemBioFingerprintAuthService |
|---|
Return Value
instance of this class
Availability
4.6
Declared In
EMSystemBioFingerprintContainer.h
– authenticateUser:withMessage:fallbackTitle:completionHandler:
Authenticate user by Touch ID with PIN fallback feature. By using this API, the application could customize the action upon error cases. The completion handler will return an EMSystemBioFingerprintAuthInput object and Touch ID evaluatedPolicyDomainState upon success. The EMSystemBioFingerprintAuthInput object can be used to generate OTPs.
- (void)authenticateUser:(id<EMAuthenticatable>)authenticatable withMessage:(NSString *)localizedMessage fallbackTitle:(NSString *)fallbackTitle completionHandler:(void ( ^ ) ( id<EMSystemBioFingerprintAuthInput> bioFpAuthInput , NSData *evaluatedPolicyDomainState , NSError *error ))completionHandlerParameters
authenticatable |
the target authenticatable item (e.g. CapToken) |
|---|---|
localizedMessage |
the message that will be displayed on Touch ID |
fallbackTitle |
the fallback title. If set to empty string, the button will be hidden. |
completionHandler |
completion handler to be called with the result once it’s completed. Touch ID evaluatedPolicyDomainState data will be returned upon success. [error code] will contain EM_STATUS_AUTHENTICATION_CANCELED_USER_FALLBACK if user tapped the fallback button. |
Availability
4.6
Discussion
Warning: PIN fallback feature only works on iOS9.0+. [error code] will contains EM_STATUS_AUTHENTICATION_USER_FALLBACK_IS_NOT_SUPPORTED if the application run it on unsupported OS.
Declared In
EMSystemBioFingerprintContainer.h
– cancelAuthentication
Cancel biometric fingerprint authentication prompt.
- (void)cancelAuthenticationAvailability
5.0
Declared In
EMSystemBioFingerprintContainer.h