Package org.robolectric.shadows

Class ShadowBiometricPrompt

java.lang.Object

org.robolectric.shadows.ShadowBiometricPrompt

@Implements(className="android.hardware.biometrics.BiometricPrompt",
            minSdk=28,
            isInAndroidSdk=false)
public class ShadowBiometricPrompt
extends Object

Provides testing APIs for BiometricPrompt

Constructor Summary

Constructors

Constructor	Description
ShadowBiometricPrompt()

Method Summary

Modifier and Type	Method	Description
protected void	authenticate(BiometricPrompt.CryptoObject crypto, CancellationSignal cancel, Executor executor, BiometricPrompt.AuthenticationCallback callback)
protected void	authenticate(CancellationSignal cancel, Executor executor, BiometricPrompt.AuthenticationCallback callback)
static void	authenticateCurrentSessionSuccessfully()	Simulates a successful authentication and triggers BiometricPrompt.AuthenticationCallback.onAuthenticationSucceeded(android.hardware.biometrics.BiometricPrompt.AuthenticationResult).
static void	authenticateCurrentSessionWithError(int errorCode, String message)	Simulates an error authentication and triggers BiometricPrompt.AuthenticationCallback.onAuthenticationError(int, java.lang.CharSequence).
static void	cancelCurrentSession()	Cancels the current authentication session and triggers CancellationSignal.cancel().
static void	failCurrentSessionOnce()	Simulates a failed authentication by triggering BiometricPrompt.AuthenticationCallback.onAuthenticationFailed().
static BiometricPrompt	getCurrentPrompt()	Returns the BiometricPrompt for the current authentication session, or null if there is no session in progress.
static void	reset()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShadowBiometricPrompt

public ShadowBiometricPrompt()

Method Details

reset

@Resetter
public static void reset()

getCurrentPrompt

@Nullable
public static BiometricPrompt getCurrentPrompt()

Returns the BiometricPrompt for the current authentication session, or null if there is no session in progress.

Use this method to check if an authentication session is in progress, and/or to perform additional assertions on the BiometricPrompt being shown such as its title or description.

cancelCurrentSession

public static void cancelCurrentSession()

Cancels the current authentication session and triggers CancellationSignal.cancel().

authenticateCurrentSessionSuccessfully

public static void authenticateCurrentSessionSuccessfully()

Simulates a successful authentication and triggers BiometricPrompt.AuthenticationCallback.onAuthenticationSucceeded(android.hardware.biometrics.BiometricPrompt.AuthenticationResult).

authenticateCurrentSessionWithError

public static void authenticateCurrentSessionWithError(int errorCode,
 String message)

Simulates an error authentication and triggers BiometricPrompt.AuthenticationCallback.onAuthenticationError(int, java.lang.CharSequence).

Parameters:

errorCode - The error code to be returned.

message - The error message to be returned.

failCurrentSessionOnce

public static void failCurrentSessionOnce()

Simulates a failed authentication by triggering BiometricPrompt.AuthenticationCallback.onAuthenticationFailed().

Note that this does not clear the current session. A failed authentication typically means the user can retry.

authenticate

@Filter(order=AFTER)
protected void authenticate(CancellationSignal cancel,
 Executor executor,
 BiometricPrompt.AuthenticationCallback callback)

authenticate

@Filter(order=AFTER)
protected void authenticate(BiometricPrompt.CryptoObject crypto,
 CancellationSignal cancel,
 Executor executor,
 BiometricPrompt.AuthenticationCallback callback)