Package org.robolectric.shadows

Class ShadowFingerprintManager

java.lang.Object

org.robolectric.shadows.ShadowFingerprintManager

@Implements(value=android.hardware.fingerprint.FingerprintManager.class,
            minSdk=23)
public class ShadowFingerprintManager
extends Object

Provides testing APIs for FingerprintManager

Field Summary

Fields

Modifier and Type	Field	Description
protected static FingerprintManager.CryptoObject	pendingCryptoObject

Constructor Summary

Constructors

Constructor	Description
ShadowFingerprintManager()

Method Summary

Modifier and Type	Method	Description
protected void	authenticate(FingerprintManager.CryptoObject crypto, CancellationSignal cancel, int flags, FingerprintManager.AuthenticationCallback callback, Handler handler)	Success or failure can be simulated with a subsequent call to authenticationSucceeds() or authenticationFails().
void	authenticationFails()	Simulates a failed fingerprint authentication.
void	authenticationSucceeds()	Simulates a successful fingerprint authentication.
protected FingerprintManager.AuthenticationResult	createAuthenticationResult()
protected List<Fingerprint>	getEnrolledFingerprints()
int	getFingerprintId(int index)
protected List<FingerprintSensorPropertiesInternal>	getSensorPropertiesInternal()
protected boolean	hasEnrolledFingerprints()	Returns false by default, or the value specified via setHasEnrolledFingerprints(boolean).
protected boolean	isHardwareDetected()
static void	reset()
void	setDefaultFingerprints(int num)	Enrolls the given number of fingerprints, which will be returned in getEnrolledFingerprints().
void	setHasEnrolledFingerprints(boolean hasEnrolledFingerprints)	Deprecated. use setDefaultFingerprints(int) instead.
void	setIsHardwareDetected(boolean isHardwareDetected)	Sets the return value of FingerprintManager.isHardwareDetected().

Methods inherited from class java.lang.Object

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

Field Details

pendingCryptoObject

protected static FingerprintManager.CryptoObject pendingCryptoObject

Constructor Details

ShadowFingerprintManager

public ShadowFingerprintManager()

Method Details

reset

@Resetter
public static void reset()

authenticationSucceeds

public void authenticationSucceeds()

Simulates a successful fingerprint authentication. An authentication request must have been issued with FingerprintManager.authenticate(CryptoObject, CancellationSignal, int, AuthenticationCallback, Handler) and not cancelled.

createAuthenticationResult

protected FingerprintManager.AuthenticationResult createAuthenticationResult()

authenticationFails

public void authenticationFails()

Simulates a failed fingerprint authentication. An authentication request must have been issued with FingerprintManager.authenticate(CryptoObject, CancellationSignal, int, AuthenticationCallback, Handler) and not cancelled.

authenticate

@Implementation
protected void authenticate(FingerprintManager.CryptoObject crypto,
 CancellationSignal cancel,
 int flags,
 FingerprintManager.AuthenticationCallback callback,
 Handler handler)

Success or failure can be simulated with a subsequent call to authenticationSucceeds() or authenticationFails().

setHasEnrolledFingerprints

@Deprecated
public void setHasEnrolledFingerprints(boolean hasEnrolledFingerprints)

Deprecated.

use setDefaultFingerprints(int) instead.

Sets the return value of FingerprintManager.hasEnrolledFingerprints().

hasEnrolledFingerprints

@Implementation
protected boolean hasEnrolledFingerprints()

Returns false by default, or the value specified via setHasEnrolledFingerprints(boolean).

getEnrolledFingerprints

@HiddenApi
@Implementation
protected List<Fingerprint> getEnrolledFingerprints()

Returns:

lists of current fingerprint items, the list be set via setDefaultFingerprints(int)

getFingerprintId

public int getFingerprintId(int index)

Returns:

Returns the finger ID for the given index.

setDefaultFingerprints

public void setDefaultFingerprints(int num)

Enrolls the given number of fingerprints, which will be returned in getEnrolledFingerprints().

Parameters:

num - the quantity of fingerprint item.

setIsHardwareDetected

public void setIsHardwareDetected(boolean isHardwareDetected)

Sets the return value of FingerprintManager.isHardwareDetected().

isHardwareDetected

@Implementation(minSdk=23)
protected boolean isHardwareDetected()

Returns:

false by default, or the value specified via setIsHardwareDetected(boolean)

getSensorPropertiesInternal

@Implementation(minSdk=31)
protected List<FingerprintSensorPropertiesInternal> getSensorPropertiesInternal()