EMAuthenticatable Protocol Reference
| Conforms to | NSObject |
|---|---|
| Declared in | EMAuthenticatable.h |
Overview
Authenticatable protocol. Authenticatable refers to some asset which could be authenticated with multi-authentication modes once configured.
– isAuthModeActive:
required method
Check if a mode has already been activated for this authenticatable.
- (BOOL)isAuthModeActive:(id<EMAuthMode>)authModeParameters
authMode |
the authentication mode to be check. |
|---|
Return Value
‘YES’ if mode is active, ‘NO’ otherwise.
Availability
3.2
Declared In
EMAuthenticatable.h
– activatedModes
required method
Get the list of authentication modes that have been activated for this authenticatable.
- (NSSet *)activatedModesReturn Value
list of activated modes.
Availability
3.2
Declared In
EMAuthenticatable.h
– activateAuthMode:usingActivatedInput:error:
required method
Activate an authentication mode. An active authentication input is required to access protected data. Currently, only supports using EMPinAuthMode to activate EMBioFingerprintAuthMode.
Prior to activate the mode, this method will check if it is well-configured on the platform.
- (BOOL)activateAuthMode:(id<EMAuthMode>)authMode usingActivatedInput:(id<EMAuthInput>)activatedAuthInput error:(NSError **)errorParameters
authMode |
The authentication mode to activate. |
|---|---|
activatedAuthInput |
The authentication input for an activated authentication mode that gives access to protected data. |
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 |
Return Value
‘YES’ if mode has been activated, ‘NO’ otherwise.
Availability
3.2
Declared In
EMAuthenticatable.h
– deactivateAuthMode:error:
required method
Deactivate an authentication mode without user authentication.
Prior to deactivating the mode, this method will check if it is well-configured on the platform.
- (BOOL)deactivateAuthMode:(id<EMAuthMode>)authMode error:(NSError **)errorParameters
authMode |
The authentication mode to be deactivated. |
|---|---|
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 |
Return Value
‘YES’ if mode has been deactivated, ‘NO’ otherwise.
Availability
3.2
Declared In
EMAuthenticatable.h
– isMultiAuthModeEnabled
required method
Check if multi authentication mode has been enabled. This function will return true if the authenticatable has been migrated to support multi auth modes. After migration, this function will return true even when only one mode is activated.
- (BOOL)isMultiAuthModeEnabledReturn Value
if multi authentication mode has been enabled.
Availability
3.2
Declared In
EMAuthenticatable.h
– uuid
required method
Get the UUID of an Authenticatable object.
- (NSString *)uuidReturn Value
String value of UUID.
Availability
4.0
Declared In
EMAuthenticatable.h