EMAuthService Protocol Reference

Conforms to NSObject
Declared in EMAuthService.h

Overview

A protocol that represents authentication service.

– authMode required method

Get authentication mode reference corresponding to this service.

- (id<EMAuthMode>)authMode

Return Value

current auth mode.

Availability

3.2

Declared In

EMAuthService.h

– isSupported: required method

Indicates if the authentication mode is supported by the hardware.

- (BOOL)isSupported:(NSError **)error

Parameters

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

‘YES’ if authentication is supported, ‘NO’ otherwise.

Availability

3.2

Declared In

EMAuthService.h

– isConfigured: required method

Indicates if the authentication mode is configured and ready for use. For example, a user may need to configure the OS to use a particular feature, such as TouchID, Face ID, before this authentication mode can be used.

- (BOOL)isConfigured:(NSError **)error

Parameters

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

‘YES’ if the platform is correctly configured to support the authentication mode; ‘NO’ otherwise.

Availability

3.2

Discussion

TouchID authentication mode is configured only if the following conditions met: 1. At least one touch ID user is registered into the system 2. Touch ID service is available. If the touch ID is temporarily locked out because there were too many failed Touch ID attempts, the function will return false and an error.

Face ID authentication mode is configured only if the following conditions met: 1. Face ID authentication service is initialized, and 2. One user is enrolled.

Declared In

EMAuthService.h