LocalAuthPlatform class abstract
The interface that implementations of local_auth must implement.
Platform implementations should extend this class rather than implement it as local_auth
does not consider newly added methods to be breaking changes. Extending this class
(using extends
) ensures that the subclass will get the default implementation, while
platform implementations that implements
this interface will be broken by newly added
LocalAuthPlatform methods.
- Inheritance
-
- Object
- PlatformInterface
- LocalAuthPlatform
- Implementers
Constructors
- LocalAuthPlatform()
- Constructs a LocalAuthPlatform.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
authenticate(
{required String localizedReason, required Iterable< AuthMessages> authMessages, AuthenticationOptions options = const AuthenticationOptions()}) → Future<bool> - Authenticates the user with biometrics available on the device while also allowing the user to use device authentication - pin, pattern, passcode.
-
deviceSupportsBiometrics(
) → Future< bool> - Returns true if the device is capable of checking biometrics.
-
getEnrolledBiometrics(
) → Future< List< BiometricType> > - Returns a list of enrolled biometrics.
-
isDeviceSupported(
) → Future< bool> - Returns true if device is capable of checking biometrics or is able to fail over to device credentials.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
stopAuthentication(
) → Future< bool> - Cancels any authentication currently in progress.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- instance ↔ LocalAuthPlatform
-
The default instance of LocalAuthPlatform to use.
getter/setter pair