futuraekit-java/com.futurae.sdk/FuturaeClient/unlockWithBiometricsDeviceCredentials

unlockWithBiometricsDeviceCredentials

public final Unit unlockWithBiometricsDeviceCredentials(FragmentActivity activity, String promptTitle, String promptSubtitle, String promptDescription, Callback<UserPresenceVerification> callback)

Unlocking method that should be called prior to using a locked functionality, when the SDK LockConfigurationType is BIOMETRICS_OR_DEVICE_CREDENTIALS. This will display a biometric prompt (or other device-credential authentication) to authenticate the user and depending on its result will unlock the SDK.

Parameters

activity

the activity that will present the biometric authentication to the user.

promptTitle

the title used for the authentication prompt.

promptSubtitle

the subtitle used for the authentication prompt.

promptDescription

the description used for the authentication prompt.

callback

used to receive the response of the unlock request.

See also

Throws

if none of the supported authentication methods are available.

if the SDKConfiguration uses setInvalidatedByBiometricChange(true) and biometrics of the device have been changed or invalidated. This is a security concern and will render the biometric authentication unusable.

For all lock configuration types except SDK_PIN_WITH_BIOMETRICS_OPTIONAL the SDK will need to be reset and re-initialized.

For the case of SDK_PIN_WITH_BIOMETRICS_OPTIONAL the app may either reset and re-initialize the SDK or re-activate Biometrics.

if SDK is configured with BIOMETRICS_ONLY, BIOMETRICS_OR_DEVICE_CREDENTIALS or NONE.

if any of the specified arguments are invalid.