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 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

[local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions #11901

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
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();
}