EMBioFingerprintContainer Class Reference

Inherits from NSObject
Declared in EMBioFingerprintContainer.h

Overview

The biometric fingerprint authentication container.

Warning: Do not subclass this interface.

Warning: This API is deprecated since 4.6, it is replaced with EMSystemBioFingerprintContainer

+ containerWithBioFingerprintAuthService:

Designated constructor. Returns the EMBioFingerprintContainer object created using the EMBioFingerprintAuthService

+ (EMBioFingerprintContainer *)containerWithBioFingerprintAuthService:(EMBioFingerprintAuthService *)service

Parameters

service

the instance of EMBioFingerprintAuthService

Return Value

instance of this class

Availability

4.0

Declared In

EMBioFingerprintContainer.h

– authenticateUser:withMessage:error:

Authenticate user by Touch ID, returns an EMBioFingerprintAuthInput object upon success, that can be used to generate OTPs.

- (id<EMBioFingerprintAuthInput>)authenticateUser:(id<EMAuthenticatable>)authenticatable withMessage:(NSString *)localizedMessage error:(NSError **)error

Parameters

authenticatable

the target authenticatable item (e.g. CapToken)
localizedMessage

the message that will be displayed on Touch ID
error

If an error occurs, upon return contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.

Return Value

instance of this class

Availability

4.0

Declared In

EMBioFingerprintContainer.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 EMBioFingerprintAuthInput object upon success, that can be used to generate OTPs.

- (void)authenticateUser:(id<EMAuthenticatable>)authenticatable withMessage:(NSString *)localizedMessage fallbackTitle:(NSString *)fallbackTitle completionHandler:(void ( ^ ) ( id<EMBioFingerprintAuthInput> bioFpAuthInput , NSError *error ))completionHandler

Parameters

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. [error code] will contain EM_STATUS_AUTHENTICATION_CANCELED_USER_FALLBACK if user tapped the fallback button.

Availability

4.1

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

EMBioFingerprintContainer.h

– authenticateUserV2: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 EMBioFingerprintAuthInput object and Touch ID evaluatedPolicyDomainState upon success. The EMBioFingerprintAuthInput object can be used to generate OTPs.

- (void)authenticateUserV2:(id<EMAuthenticatable>)authenticatable withMessage:(NSString *)localizedMessage fallbackTitle:(NSString *)fallbackTitle completionHandler:(void ( ^ ) ( id<EMBioFingerprintAuthInput> bioFpAuthInput , NSData *evaluatedPolicyDomainState , NSError *error ))completionHandler

Parameters

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.1.1

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

EMBioFingerprintContainer.h

– cancelAuthentication

Cancel biometric fingerprint authentication prompt.

- (void)cancelAuthentication

Availability

5.0

Declared In

EMBioFingerprintContainer.h