Skip to content

Commit 8bed63e

Browse files
author
anirudhsharma
committed
Clarify getAvailableBiometrics documentation regarding iOS permissions
1 parent 0346a5d commit 8bed63e

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

packages/local_auth/local_auth/lib/src/local_auth.dart

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,13 @@ class LocalAuthentication {
8888
/// fail over to device credentials.
8989
Future<bool> isDeviceSupported() async => LocalAuthPlatform.instance.isDeviceSupported();
9090

91-
/// Returns a list of enrolled biometrics.
91+
/// Returns a list of the biometrics that the app can currently use for
92+
/// authentication.
93+
///
94+
/// Note that this may not include all biometrics enrolled on the device.
95+
/// For example, on iOS, biometrics may be enrolled on the device but
96+
/// remain unavailable to the app if the user has not granted the required
97+
/// permissions to use them.
9298
Future<List<BiometricType>> getAvailableBiometrics() =>
9399
LocalAuthPlatform.instance.getEnrolledBiometrics();
94100
}

0 commit comments

Comments
 (0)