public class FaceAuthService extends Object implements AuthService
Modifier and Type | Method and Description |
---|---|
void |
configureLicense(FaceAuthLicense faceAuthLicense,
FaceAuthLicenseConfigurationCallback faceAuthLicenseConfigurationCallback)
Configure license.
|
static FaceAuthService |
create(AuthenticationModule module)
Create face authentication service which is the entry point of face
authentication feature.
|
FaceAuthMode |
getAuthMode()
Get authentication mode reference corresponding to this service.
|
FaceAuthFactory |
getFaceAuthFactory()
Get
FaceAuthFactory for Face object creation |
void |
initialize(FaceAuthInitializeCallback callback)
Initialize the biometric face engine.
|
boolean |
isConfigured()
Indicates if the authentication mode is configured and ready for use.
|
boolean |
isInitialized()
Indicates if the library has been initialized.
|
boolean |
isLicenseConfigured()
Deprecated.
|
boolean |
isMigrationNeededForAndroidQ()
Check if the migration is needed for Android Q.
|
boolean |
isSupported()
Indicates if the authentication mode is supported by the hardware and OS.
|
void |
migrateForAndroidQ()
Migrate the old data to be compatible with Android Q.
|
boolean |
reset()
Cleanup the data associated with FaceID.
|
static void |
setContext(android.content.Context context)
Deprecated.
|
void |
uninitialize()
Uninitialize the biometric face engine.
|
public static FaceAuthService create(AuthenticationModule module)
module
- @Deprecated public static void setContext(android.content.Context context)
public void initialize(FaceAuthInitializeCallback callback)
setContext(Context)
.callback
- callback to be invoked upon completion of this operationpublic void configureLicense(FaceAuthLicense faceAuthLicense, FaceAuthLicenseConfigurationCallback faceAuthLicenseConfigurationCallback)
faceAuthLicense
- the FaceAuthLicense
faceAuthLicenseConfigurationCallback
- callback to be invoked upon completion of this operationIdpAuthException
@Deprecated public boolean isLicenseConfigured()
configureLicense(FaceAuthLicense, FaceAuthLicenseConfigurationCallback)
is always required to be calledpublic void uninitialize()
public boolean isInitialized()
public FaceAuthFactory getFaceAuthFactory()
FaceAuthFactory
for Face object creationpublic FaceAuthMode getAuthMode()
getAuthMode
in interface AuthService
public boolean isSupported()
isSupported
in interface AuthService
public boolean isConfigured()
isConfigured
in interface AuthService
public boolean reset() throws IdpException
IdpException
- failure during cleanup. Refer to error code and error message for the details.IdpCore.reset()
public boolean isMigrationNeededForAndroidQ() throws IdpException
migrateForAndroidQ()
.
NOTE: This API should be called during the application startup to make sure that the permission popup, if any, will not interfere with other business flow.
For more information on Android Q privacy changes, refer to https://developer.android.com/preview/privacy/data-identifiers#device-ids
IdpException
- When database operation failed.migrateForAndroidQ()
public void migrateForAndroidQ() throws IdpException
For more information on Android Q privacy changes, refer to https://developer.android.com/preview/privacy/data-identifiers#device-ids
IdpException
- When database operation failed.isMigrationNeededForAndroidQ()