Clerk Android API/com.clerk.api.biometriccredential/BiometricCredentialAvailability

BiometricCredentialAvailability

sealed interface BiometricCredentialAvailability

Local availability state for biometric sign-in.

Inheritors

Types

data object Available : BiometricCredentialAvailability

Biometric sign-in can be started with a local credential on this device.

data class Unavailable(val reason: BiometricCredentialAvailability.UnavailableReason) : BiometricCredentialAvailability

Biometric sign-in is unavailable for the given reason.

UnavailableReason

enum UnavailableReason : Enum<BiometricCredentialAvailability.UnavailableReason>

The reason biometric sign-in is unavailable.

Properties

open val isAvailable: Boolean

Whether the SDK has a local credential and key that can be used for biometric sign-in.

unavailableReason

open val unavailableReason: BiometricCredentialAvailability.UnavailableReason?

The reason biometric sign-in is unavailable, if any.