BiometricError enum

Standardized error codes for the plugin.

Inheritance
Available extensions

Values

success → const BiometricError

The operation was successful.

userCanceled → const BiometricError

The user canceled the operation.

notAvailable → const BiometricError

Biometric authentication is not available on this device.

notEnrolled → const BiometricError

No biometrics are enrolled.

lockedOut → const BiometricError

The user is temporarily locked out due to too many failed attempts.

lockedOutPermanent → const BiometricError

The user is permanently locked out until they log in with a strong method.

keyNotFound → const BiometricError

The requested key was not found.

keyInvalidated → const BiometricError

The key has been invalidated (e.g. by new biometric enrollment).

unknown → const BiometricError

An unknown error occurred.

invalidInput → const BiometricError

The input payload was invalid (e.g. not valid Base64).

securityUpdateRequired → const BiometricError

A security update is required before biometrics can be used.

notSupported → const BiometricError

Biometric authentication is not supported on this device/OS version.

systemCanceled → const BiometricError

The system canceled the operation (e.g., app went to background).

promptError → const BiometricError

Failed to show the biometric prompt (e.g., activity not available).

keyAlreadyExists → const BiometricError

A key with the specified alias already exists and failIfExists was set.

fallbackSelected → const BiometricError

The user selected a custom fallback option instead of authenticating. Android 15+ only Check selectedFallbackIndex and selectedFallbackText on the result object to determine which option was selected.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<BiometricError>
A constant List of the values in this enum, in order of their declaration.