Guardo class
A widget that provides a biometric authentication gate for your app
This widget will handle the authentication flow and only show the authenticated content when the user has successfully authenticated.
- Inheritance
Constructors
- Guardo({Key? key, required Widget child, Widget? loadingWidget, Widget? failedWidget, LockScreenBuilder? lockScreen, GuardoConfig? config, GuardoService? guardoService, void onAuthenticationChanged(bool isAuthenticated)?, bool autoRetry = true, bool enabled = true})
-
const
Properties
- autoRetry → bool
-
Whether to automatically retry authentication on app resume
final
- child → Widget
-
The widget to show when the user is authenticated
final
- config → GuardoConfig?
-
Configuration for the authentication process
final
- enabled → bool
-
Whether authentication is enabled
final
- failedWidget → Widget?
-
The widget to show when authentication fails (optional)
final
- guardoService → GuardoService?
-
Custom GuardoService instance (optional)
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingWidget → Widget?
-
The widget to show while checking authentication (optional)
final
- lockScreen → LockScreenBuilder?
-
Custom lock screen builder function
Takes (BuildContext context, VoidCallback onTap) and returns a Widget
This is the preferred way to configure the lock screen
final
- onAuthenticationChanged → void Function(bool isAuthenticated)?
-
Callback when authentication state changes
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< Guardo> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String -
Returns a string representation of this node and its descendants.
inherited
-
toStringShallow(
{String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String -
Returns a one-line detailed description of the object.
inherited
-
toStringShort(
) → String -
A short, textual description of this widget.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited