FingerprintManager(android.app.Activity activity, java.util.concurrent.Executor executor, BioAuthnCallback callback)

Constructs a FingerprintManager object for fingerprint authentication. The object is used to call the BioAuthn fingerprint authentication API of HUAWEI FIDO.

FingerprintManager(android.app.Fragment fragment, java.util.concurrent.Executor executor, BioAuthnCallback callback)

Constructs a FingerprintManager object for fingerprint authentication. The object is used to call the BioAuthn fingerprint authentication API of HUAWEI FIDO.

canAuth()

Checks whether fingerprint authentication is available.

auth(final CryptoObject crypto)

Performs fingerprint authentication. This method is associated with a private key or public-private key pair, which can be used only after the user passes the fingerprint authentication.

auth()

Performs fingerprint authentication.

cancelAuth()

Cancels fingerprint authentication.

Value: 0

The obtained fingerprint image is good.

Value: 1

The detected fingerprint image is incomplete. If this error occurs during registration, provide a solution for the user, for example, pressing the sensor with force.

Value: 2

The fingerprint image is too noisy due to a detected condition (that is, dry skin) or a possible dirty sensor. For details about the constant indicating a dirty sensor, please refer to FINGERPRINT_ACQUIRED_IMAGER_DIRTY.

Value: 3

The fingerprint image is too noisy due to suspected or detected dirt on the sensor. For example, if FINGERPRINT_ACQUIRED_INSUFFICIENT is returned for multiple times or dirt is detected on the sensor (such as a stuck pixel or stripe), this value can be returned. When a user attempts to use the sensor again, ask the user to clean the sensor first.

Value: 4

The fingerprint image cannot be read due to lack of motion. This constant is most applicable to scenarios where linear array sensors that require sliding are used.

Value: 5

The fingerprint image is incomplete due to quick motion. This error is most appropriate for linear array sensors. However, if a user moves their finger during fingerprint collection, this error may also occur. You shall ask the user to slowly (linearly) move their finger or place their finger on the sensor for a longer time.

Value: 1012

Returned using the helpCode parameter in the onAuthHelp method of BioAuthnCallback when the auth method is called.The fingerprint does not match.

Value: 0

Fingerprint authentication is available (with registered fingerprints and available authentication hardware).

Value: 1

Hardware is unavailable.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 2

The sensor cannot process the current fingerprint image.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 3

The current request timed out. The timeout mechanism prevents infinite waiting for the fingerprint sensor’s response. The timeout interval varies according to the user device and sensor. Generally, the timeout interval is 30 seconds.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 4

The storage space is insufficient for the operation such as registration.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 5

The operation is canceled because the fingerprint authentication sensor is unavailable.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 7

The operation is canceled because the API is locked when the number of attempts reaches the maximum. The API is locked for 30 seconds after five attempt failures.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 8

A vendor-defined error occurred.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 9

The operation is canceled when the number of fingerprint authentication locking times reaches the maximum. Then, fingerprint authentication is disabled until the user is authenticated in a stronger authentication mode, including PIN, pattern, and password authentication.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 10

The user cancels the fingerprint authentication. After receiving this error code, the app enables the standby authentication mode, for example, password authentication. The app also needs to provide the fingerprint authentication enabling method, for example, a button.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 1001

The device failed the system integrity check, for example, the device has been rooted or the system integrity has been damaged.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 1002

The fingerprint authentication result failed the key-based encryption verification.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 1003

HMS Core framework error.

Returned using the errorCode parameter in the onAuthError method of BioAuthnCallback when the auth method is called.Value: 1004

This version of operating system does not support fingerprint authentication. Fingerprint authentication of FIDO BioAuthn is available only to devices running Android 6.0 or later.

FINGERPRINT_SUCCESS: 

Fingerprint authentication is available (with registered fingerprints and available authentication hardware).

FINGERPRINT_ERROR_HW_UNAVAILABLE: 

Hardware is unavailable.

FINGERPRINT_ERROR_NO_FINGERPRINTS: 

The user has not registered any fingerprints.

FINGERPRINT_ERROR_NO_HARDWARE: 

No fingerprint authentication hardware is provided.

FINGERPRINT_ERROR_UNSUPPORTED_OS_VER:

This version of operating system does not support fingerprint authentication.