Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2927d2c6 authored by Kevin Chyn's avatar Kevin Chyn
Browse files

Update BiometricPrompt documentation

Bug: 128452510

Test: Builds
Change-Id: I561324c90e8beb25aefd16c3b656c40db0588f15
parent 4511eb42
Loading
Loading
Loading
Loading
+10 −0
Original line number Diff line number Diff line
@@ -523,6 +523,11 @@ public class BiometricPrompt implements BiometricAuthenticator, BiometricConstan
     * cancelled notification through {@link AuthenticationCallback#onAuthenticationError(int,
     * CharSequence)}.
     *
     * Note: Applications generally should not cancel and start authentication in quick succession.
     * For example, to properly handle authentication across configuration changes, it's recommended
     * to use BiometricPrompt in a fragment with setRetainInstance(true). By doing so, the
     * application will not need to cancel/restart authentication during the configuration change.
     *
     * @throws IllegalArgumentException If any of the arguments are null
     *
     * @param crypto Object associated with the call
@@ -568,6 +573,11 @@ public class BiometricPrompt implements BiometricAuthenticator, BiometricConstan
     * authentication. The interrupted client will receive a cancelled notification through {@link
     * AuthenticationCallback#onAuthenticationError(int, CharSequence)}.
     *
     * Note: Applications generally should not cancel and start authentication in quick succession.
     * For example, to properly handle authentication across configuration changes, it's recommended
     * to use BiometricPrompt in a fragment with setRetainInstance(true). By doing so, the
     * application will not need to cancel/restart authentication during the configuration change.
     *
     * @throws IllegalArgumentException If any of the arguments are null
     *
     * @param cancel An object that can be used to cancel authentication