BioAuthnPrompt(androidx.fragment.app.FragmentActivity fragmentActivity, java.util.concurrent.Executor executor, BioAuthnCallback callback)

Constructs a BioAuthnPrompt object for fingerprint authentication, which is used to call the fingerprint authentication API of FIDO BioAuthn.

auth(final BioAuthnPrompt.PromptInfo info, final CryptoObject crypto) 

Displays a fingerprint authentication pop-up for the user. Associates with a private key or a public-private key pair, which can be used only after the user passes the fingerprint authentication.

auth(final BioAuthnPrompt.PromptInfo info)

Displays a fingerprint authentication pop-up for users.

cancelAuth()

Closes the fingerprint authentication pop-up.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 1

Hardware is unavailable. Try again later.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 2

The sensor cannot process the current fingerprint image.

Returned in the errorCode parameter sent by 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 depending on the user device and sensor. Generally, the timeout interval is 30 seconds.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 4

The storage space is insufficient for operations such as registration.

Returned in the errorCode parameter sent by 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 in the errorCode parameter sent by 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 consecutive attempt failures.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 8

Vendor-defined errors.

Returned in the errorCode parameter sent by 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 and password authentication.

Returned in the errorCode parameter sent by 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 in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 11

The user has not registered any fingerprints.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 12

The user device is not equipped with a fingerprint sensor.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 13

The user cancels the authentication.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 14

No PIN or password is set for the device.

Returned in the errorCode parameter sent by 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, the device ROM has been flashed, or the system has been damaged.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 1002

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

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 1003

HMS Core Framework error.

Returned in the errorCode parameter sent by the onAuthError method of BioAuthnCallback when the auth method is called.

Value: 1004

This version of operating system does not support fingerprint authentication. The EMUI version of a user device supporting fingerprint authentication of FIDO BioAuthn must be 5.0.0 or later.