Skip to content

[local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions#11901

Merged
auto-submit[bot] merged 4 commits into
flutter:mainfrom
anirudhsharma392:fix-local-auth-doc
Jul 9, 2026
Merged

[local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions#11901
auto-submit[bot] merged 4 commits into
flutter:mainfrom
anirudhsharma392:fix-local-auth-doc

Conversation

@anirudhsharma392

@anirudhsharma392 anirudhsharma392 commented Jun 14, 2026

Copy link
Copy Markdown
Contributor

Clarifies the getAvailableBiometrics docstring to explain that it returns biometrics available for the app to use, which may not include all enrolled biometrics (e.g., if iOS permission has not been granted).

Fixes: flutter/flutter#187512

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Exceptions

  • Test Exemption: This PR is exempt from testing because it is a documentation-only change.

Footnotes

  1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. 2

@google-cla

google-cla Bot commented Jun 14, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation for the getAvailableBiometrics method in LocalAuthentication to clarify that it returns only the biometrics currently available for the app's use, noting that some enrolled biometrics may be excluded due to missing user permissions. There are no review comments, and no additional feedback is provided.

@anirudhsharma392 anirudhsharma392 changed the title Clarify getAvailableBiometrics documentation regarding iOS permissions [local_auth] Clarify getAvailableBiometrics documentation regarding iOS permissions Jun 14, 2026
@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

Thanks for the contribution!

  • I signed the CLA.

The email associated with the commit does not correspond to a signed CLA. If you intended to use a different email address for your contribution, you will need to adjust your git configuration, amend the commit, and re-push.

Could you quote the part of the linked instructions that you believe say that documentation changes are exempt from versioning and changelog?

@anirudhsharma392

anirudhsharma392 commented Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

@stuartmorgan-g My apologies, I misread the guidelines here.
Screenshot 2026-06-15 at 2 04 34 PM

Since this is a doc comment on a public API (getAvailableBiometrics), So shall i go ahead and bump the version?
(PS: Just confirming so we are on the same page)

@stuartmorgan-g

Copy link
Copy Markdown
Collaborator

@anirudhsharma392 I'm not sure I understand the question. Is something about the FAQ in that screenshot unclear?

@anirudhsharma392

anirudhsharma392 commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

@stuartmorgan-g It was my bad, Never mind, I have now signed the CLA and pushed the updated commit containing the version bump and CHANGELOG.

@anirudhsharma392

Copy link
Copy Markdown
Contributor Author

Hi @stuartmorgan-g, I’ve addressed the issues. Could you take another look when you get a chance? Thanks!

@stuartmorgan-g
stuartmorgan-g self-requested a review June 23, 2026 18:37

@stuartmorgan-g stuartmorgan-g left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bparrishMines bparrishMines added the CICD Run CI/CD label Jul 8, 2026

@bparrishMines bparrishMines left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bparrishMines bparrishMines added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 8, 2026
@auto-submit
auto-submit Bot merged commit 84e73e8 into flutter:main Jul 9, 2026
89 checks passed
Renzo-Olivares pushed a commit to mvincentong/flutter that referenced this pull request Jul 9, 2026
…r#189194)

flutter/packages@52d84d6...20928d5

2026-07-09 44525804+sailendrabathi@users.noreply.github.com
[video_player_android] Implement backBufferDurationMs in ExoPlayer
(flutter/packages#12124)
2026-07-09 bolling.ludwig@gmail.com [camera_platform_interface] Make
setJpegImageQuality default a no-op (flutter/packages#12123)
2026-07-09 36081049+anirudhsharma392@users.noreply.github.com
[local_auth] Clarify getAvailableBiometrics documentation regarding iOS
permissions (flutter/packages#11901)
2026-07-09 stuartmorgan@google.com [ci] Add a third web Dart unit test
shard (2/2) (flutter/packages#12150)
2026-07-08 stuartmorgan@google.com [ci] Add a third web Dart unit test
shard (1/2) (flutter/packages#12138)
2026-07-08 43054281+camsim99@users.noreply.github.com Add pre-commit
hook to verify static analysis passes & format is correct
(flutter/packages#11941)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com on the revert to ensure that a
human
is aware of the problem.

To file a bug in Flutter:
https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmit Merge PR when tree becomes green via auto submit App CICD Run CI/CD p: local_auth

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[local_auth] Fix documentation for getAvailableBiometrics

3 participants