EMSystemFaceAuthContainer Class Reference

Inherits from NSObject
Declared in EMSystemFaceAuthContainer.h

Overview

The biometric Face ID authentication container.

Warning: Do not subclass this interface.

+ containerWithNativeFaceAuthService:

Designated constructor. Returns the EMSystemFaceAuthContainer object created using the EMSystemFaceAuthService

+ (EMSystemFaceAuthContainer *)containerWithNativeFaceAuthService:(EMSystemFaceAuthService *)service

Parameters

service

the instance of EMSystemFaceAuthService

Return Value

instance of this class

Availability

4.6

Declared In

EMSystemFaceAuthContainer.h

– authenticateUser:withMessage:fallbackTitle:completionHandler:

Authenticate user by face ID with PIN fallback feature. By using this API, the application could customize the action upon error cases. The completion handler will return an EMSystemFaceAuthInput object and face ID evaluatedPolicyDomainState upon success. The EMSystemFaceAuthInput object can be used to generate OTPs.

- (void)authenticateUser:(id<EMAuthenticatable>)authenticatable withMessage:(NSString *)localizedMessage fallbackTitle:(NSString *)fallbackTitle completionHandler:(void ( ^ ) ( id<EMSystemFaceAuthInput> faceAuthInput , NSData *evaluatedPolicyDomainState , NSError *error ))completionHandler

Parameters

authenticatable

the target authenticatable item (e.g. CapToken)

localizedMessage

the message that will be displayed on face 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. face 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

Declared In

EMSystemFaceAuthContainer.h

– cancelAuthentication

Cancel biometric Face ID authentication prompt.

- (void)cancelAuthentication

Availability

5.0

Declared In

EMSystemFaceAuthContainer.h