BiometricPrompt.CryptoObject

public static class BiometricPrompt.CryptoObject
extends Object

java.lang.Object
   ↳ androidx.biometric.BiometricPrompt.CryptoObject


A wrapper class for the crypto objects supported by BiometricPrompt. Currently, the framework supports Signature, Cipher, and Mac objects.

Summary

Public constructors

CryptoObject(Signature signature)

Creates a BiometricPrompt.CryptoObject that wraps the given Signature object.

CryptoObject(Cipher cipher)

Creates a BiometricPrompt.CryptoObject that wraps the given Cipher object.

CryptoObject(Mac mac)

Creates a BiometricPrompt.CryptoObject that wraps the given Mac object.

Public methods

Cipher getCipher()

Gets the Cipher object associated with this crypto object.

Mac getMac()

Gets the Mac object associated with this crypto object.

Signature getSignature()

Gets the Signature object associated with this crypto object.

Inherited methods

Public constructors

CryptoObject

public CryptoObject (Signature signature)

Creates a BiometricPrompt.CryptoObject that wraps the given Signature object.

Parameters
signature Signature: The Signature to be associated with this BiometricPrompt.CryptoObject.

CryptoObject

public CryptoObject (Cipher cipher)

Creates a BiometricPrompt.CryptoObject that wraps the given Cipher object.

Parameters
cipher Cipher: The Cipher to be associated with this BiometricPrompt.CryptoObject.

CryptoObject

public CryptoObject (Mac mac)

Creates a BiometricPrompt.CryptoObject that wraps the given Mac object.

Parameters
mac Mac: The Mac to be associated with this BiometricPrompt.CryptoObject.

Public methods

getCipher

public Cipher getCipher ()

Gets the Cipher object associated with this crypto object.

Returns
Cipher The Cipher, or null if none is associated with this object.

getMac

public Mac getMac ()

Gets the Mac object associated with this crypto object.

Returns
Mac The Mac, or null if none is associated with this object.

getSignature

public Signature getSignature ()

Gets the Signature object associated with this crypto object.

Returns
Signature The Signature, or null if none is associated with this object.