blob: 3b01ced7b93bf3ffffc43ed55d1cb9d160be01a9 [file] [log] [blame] [view]
# local_auth_platform_interface
A common platform interface for the [`local_auth`][1] plugin.
This interface allows platform-specific implementations of the `local_auth`
plugin, as well as the plugin itself, to ensure they are supporting the
same interface.
# Usage
To implement a new platform-specific implementation of `local_auth`, extend
[`LocalAuthPlatform`][2] with an implementation that performs the
platform-specific behavior, and when you register your plugin, set the default
`LocalAuthPlatform` by calling
`LocalAuthPlatform.instance = MyLocalAuthPlatform()`.
# Note on breaking changes
Strongly prefer non-breaking changes (such as adding a method to the interface)
over breaking changes for this package.
See https://flutter.dev/go/platform-interface-breaking-changes for a discussion
on why a less-clean interface is preferable to a breaking change.
[1]: ../local_auth
[2]: lib/local_auth_platform_interface.dart