LockScreenConfiguration class
Provides information needed to draw the Lock Screen, such as the pin input widget that needs to be placed on the LockScreen and available biometric methods that can be used to draw a correct icon on biometric authentication button
Constructors
-
LockScreenConfiguration({required Widget pinInputWidget, required bool isLoading, required LocalAuthFailure? error, required List<
BiometricMethod> availableBiometricMethods, required VoidCallback onBiometricAuthenticationRequested}) -
const
Properties
-
availableBiometricMethods
→ List<
BiometricMethod> -
Returns a list of available authentication methods, which can be used to draw
a correct icon on the lock screen (e.g., touch ID vs face ID icon).
If the device has no biometric authentication capabilites, or if the user has not
previously enabled biometric authentication, the returned list is empty.
final
- error → LocalAuthFailure?
-
Provides a reason for the error that occured, making it possible to display
an appropriate error message to the user
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- isLoading → bool
-
Whether authentication is a loading state, e.g., while checking
if the provided pin is correct
final
- onBiometricAuthenticationRequested → VoidCallback
-
Triggers native OS biometric authentication. Should be passed as the
onClick
parameter to the 'unlock with biometrics' buttonfinal - pinInputWidget → Widget
-
A widget through which the user can enter their pincode to authenticate
Conforms to the looks specified by PinInputBuilder
final
-
props
→ List<
Object?> -
The list of properties that will be used to determine whether
two instances are equal.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- stringify → bool?
-
If set to
true
, thetoString
method will be overridden to output this instance'sprops
.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