forgerock-core

4.4.0

forgerock-core/org.forgerock.android.auth.biometric/BiometricAuth

BiometricAuth

@RestrictTo(value = [RestrictTo.Scope.LIBRARY])

class BiometricAuth @JvmOverloads constructor(val title: String?, val subtitle: String?, val allowDeviceCredentials: Boolean, val activity: FragmentActivity, var biometricAuthListener: BiometricPrompt.AuthenticationCallback? = null, val description: String? = null)

Helper class for managing Biometric Authentication Process.

Constructors

constructor(title: String?, subtitle: String?, allowDeviceCredentials: Boolean, activity: FragmentActivity, biometricAuthListener: BiometricPrompt.AuthenticationCallback? = null, description: String? = null)

Types

object Companion

Properties

val activity: FragmentActivity

Return the activity of the client application that will host the prompt.

allowDeviceCredentials

private val allowDeviceCredentials: Boolean

biometricAuthListener

var biometricAuthListener: BiometricPrompt.AuthenticationCallback?

Return the Biometric Authentication listener used to return authentication result.

biometricManager

private var biometricManager: BiometricManager?

private val description: String? = null

The description to be displayed on the prompt.

fingerprintManager

private var fingerprintManager: FingerprintManager?

keyguardManager

var keyguardManager: KeyguardManager?

Return the mechanism used to lock and unlock the device.

private var promptInfo: BiometricPrompt.PromptInfo?

val subtitle: String?

The subtitle to be displayed on the prompt.

val title: String?

The title to be displayed on the prompt.

Functions

fun authenticate(cryptoObject: BiometricPrompt.CryptoObject? = null)

getAuthenticators

private fun getAuthenticators(): Int?

private fun handleError(logMessage: String, biometricErrorMessage: String, errorType: Int)

hasBiometricCapability

fun hasBiometricCapability(authenticators: Int): Boolean

hasDeviceCredential

fun hasDeviceCredential(): Boolean

hasEnrolledWithFingerPrint

fun hasEnrolledWithFingerPrint(): Boolean

initBiometricAuthentication

private fun initBiometricAuthentication(cryptoObject: BiometricPrompt.CryptoObject?, authenticators: Int)

initBiometricPrompt

private fun initBiometricPrompt(authenticators: Int): BiometricPrompt

setServicesFromActivity

private fun setServicesFromActivity(activity: FragmentActivity)