diff --git a/packages/local_auth/local_auth/CHANGELOG.md b/packages/local_auth/local_auth/CHANGELOG.md index 71ca732c88a5..7ea1262720db 100644 --- a/packages/local_auth/local_auth/CHANGELOG.md +++ b/packages/local_auth/local_auth/CHANGELOG.md @@ -1,6 +1,9 @@ -## NEXT +## 3.0.2 * Updates minimum supported SDK version to Flutter 3.38/Dart 3.10. +* Clarifies the `getAvailableBiometrics` documentation to explain that it + returns the biometrics available for the app to use, which may not include all + biometrics enrolled on the device. ## 3.0.1 diff --git a/packages/local_auth/local_auth/lib/src/local_auth.dart b/packages/local_auth/local_auth/lib/src/local_auth.dart index ba641e7d2141..19143ecf988d 100644 --- a/packages/local_auth/local_auth/lib/src/local_auth.dart +++ b/packages/local_auth/local_auth/lib/src/local_auth.dart @@ -88,7 +88,14 @@ class LocalAuthentication { /// fail over to device credentials. Future isDeviceSupported() async => LocalAuthPlatform.instance.isDeviceSupported(); - /// Returns a list of enrolled biometrics. + /// Returns a list of the biometric types that are available for the app to + /// use. + /// + /// This is not necessarily the same as the full set of biometrics enrolled on + /// the device; a biometric type can be enrolled but still be unavailable to + /// the app. For example, on iOS the returned list will not include a biometric + /// type if the user has denied the app permission to use it, even when that + /// biometric is enrolled on the device. Future> getAvailableBiometrics() => LocalAuthPlatform.instance.getEnrolledBiometrics(); } diff --git a/packages/local_auth/local_auth/pubspec.yaml b/packages/local_auth/local_auth/pubspec.yaml index 39133f332c04..bf35d018e959 100644 --- a/packages/local_auth/local_auth/pubspec.yaml +++ b/packages/local_auth/local_auth/pubspec.yaml @@ -2,7 +2,7 @@ name: local_auth description: Flutter plugin to allow local authentication via biometrics, passcode, pin, or pattern. repository: https://github.com/flutter/packages/tree/main/packages/local_auth/local_auth issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+local_auth%22 -version: 3.0.1 +version: 3.0.2 environment: sdk: ^3.10.0