SalesforceSDK/com.salesforce.androidsdk.security.interfaces/BiometricAuthenticationManager

BiometricAuthenticationManager

interface BiometricAuthenticationManager

Manages if the user should re-authenticate to use the app.

Properties

Link copied to clipboard
abstract var automaticPresentation: Boolean

If enabled, the SDK automatically presents the biometric opt-in dialog after a fresh login (if the user has not yet opted in) and automatically triggers the biometric prompt when the app locks (if the user has opted in). Defaults to true. Not persisted; resets to true on process restart.

Link copied to clipboard
@get:JvmName(name = "isEnabled")
abstract val enabled: Boolean

If the feature is enabled for the current user.

Link copied to clipboard
@get:JvmName(name = "isLocked")
abstract val locked: Boolean

If the device is currently locked. The users tokens will not be refreshed while locked, which can cause authenticated rest requests to fail.

Functions

Link copied to clipboard
abstract fun biometricOptIn(optIn: Boolean = true)

Enables or disables the use of biometric to skip username password authentication on the login screen to unlock the app for the current user.

Link copied to clipboard
abstract fun enableNativeBiometricLoginButton(enabled: Boolean = true)

Enables or disables a native button on the login screen that allows the user to bypass username password authentication with biometric. By default the button is enabled.

Link copied to clipboard
abstract fun hasBiometricOptedIn(): Boolean

If the current user has opted in to biometric unlock or not.

Link copied to clipboard
abstract fun lock()

Locks the device immediately. The users tokens will not be refreshed while locked, which can cause authenticated rest requests to fail.