Skip to content

[local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions #11901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anirudhsharma392 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions #11901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9941bac
Clarify getAvailableBiometrics documentation regarding iOS permissions
anirudhsharma392 Jun 15, 2026
b494243
Merge branch 'main' into fix-local-auth-doc
anirudhsharma392 Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/local_auth/local_auth/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## NEXT
## 3.0.2

* Clarifies the `getAvailableBiometrics` documentation regarding iOS permission requirements.
* Updates minimum supported SDK version to Flutter 3.38/Dart 3.10.

## 3.0.1
Expand Down
8 changes: 7 additions & 1 deletion packages/local_auth/local_auth/lib/src/local_auth.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,13 @@ class LocalAuthentication {
/// fail over to device credentials.
Future<bool> isDeviceSupported() async => LocalAuthPlatform.instance.isDeviceSupported();

/// Returns a list of enrolled biometrics.
/// Returns a list of the biometrics that the app can currently use for
/// authentication.
///
/// Note that this may not include all biometrics enrolled on the device.
/// For example, on iOS, biometrics may be enrolled on the device but
/// remain unavailable to the app if the user has not granted the required
/// permissions to use them.
Future<List<BiometricType>> getAvailableBiometrics() =>
LocalAuthPlatform.instance.getEnrolledBiometrics();
}
2 changes: 1 addition & 1 deletion packages/local_auth/local_auth/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down