com.gemalto.idp.mobile.authentication.mode.biometric

Interface BiometricAuthenticationCallbacks

public interface BiometricAuthenticationCallbacks

This interface gives an application maker the capability of using the following biometric authentication process and reports the results to the user.

Since:

5.4.0

Method Summary

Modifier and Type	Method and Description
void	onAuthenticationError(int errorCode, CharSequence errString) This callback function is called if the biometric authentication fails with an unrecoverable error but the authentication operation has completed.
void	onAuthenticationFailed() This callback function is called if a biometric is read but is not recognized (for example, a wrong finger is placed on the sensor).
void	onAuthenticationHelp(int helpCode, CharSequence helpString) This callback function is called if a recoverable error occurs during the authentication process.
void	onAuthenticationSucceeded() This callback function is called if the authentication of the biometric against the enrolled biometrics is successful - the biometric is recognized.
void	onError(IdpException e) This callback function is called if the biometric(fingerprint, face or iris) is not correctly configured or an internal cryptographic error occurs.
void	onSuccess(BiometricAuthInput biometricAuthInput) This callback function is called if: a user is successfully authenticated using biometric(fingerprint, face or iris) and an object that represents a biometric data used for OTP computation is initialized successfully The user can now use the authenticated biometric Authentication Input.

Method Detail

onSuccess

void onSuccess(BiometricAuthInput biometricAuthInput)

This callback function is called if:

• a user is successfully authenticated using biometric(fingerprint, face or iris)
• and an object that represents a biometric data used for OTP computation is initialized successfully

The user can now use the authenticated biometric Authentication Input. For example, OTP computation.

Parameters:

biometricAuthInput - represents the authenticated biometric authentication input object.

onError

void onError(IdpException e)

This callback function is called if the biometric(fingerprint, face or iris) is not correctly configured or an internal cryptographic error occurs.

Parameters:

e - an exception object indicating biometric authentication problem. An application behavior can be determined according to an exception type.

onAuthenticationError

void onAuthenticationError(int errorCode,
                           CharSequence errString)

This callback function is called if the biometric authentication fails with an unrecoverable error but the authentication operation has completed. For example, when the user has tried with an invalid biometric consecutively. For the list of error codes and descriptions, please see:

Parameters:

errorCode - the error code of the failed operation.

errString - the description of the error.

See Also:

Section 'Constants' Please note that once a user has reached the maximum number of failed attempts permitted by the system (for example, 5 failed attempts), the sensor will be locked out for about 30 Seconds depending on the OS version and manufacturer before the next attempt can be performed.

onAuthenticationHelp

void onAuthenticationHelp(int helpCode,
                          CharSequence helpString)

This callback function is called if a recoverable error occurs during the authentication process. An error can be presented to the user using a dialog fragment. It gives the user a chance of re-authenticating. For example, a finger is removed from a sensor too quickly. For the list of error codes and descriptions, please see:

Parameters:

helpCode - code of message

helpString - help string

See Also:

Section 'Constants'

onAuthenticationSucceeded

void onAuthenticationSucceeded()

This callback function is called if the authentication of the biometric against the enrolled biometrics is successful - the biometric is recognized.

onAuthenticationFailed

void onAuthenticationFailed()

This callback function is called if a biometric is read but is not recognized (for example, a wrong finger is placed on the sensor). In such cases, an error can be presented to a user through dialog fragment.