Merge "Updated aidl doc w/ regard to lockout." into udc-dev am: 4803c70715
Original change: https://googleplex-android-review.googlesource.com/c/platform/hardware/interfaces/+/21994559
Change-Id: I4f340c05d94df0b94d24fefb5e930ceeac6367a0
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
diff --git a/biometrics/face/aidl/android/hardware/biometrics/face/ISession.aidl b/biometrics/face/aidl/android/hardware/biometrics/face/ISession.aidl
index a92b366..2be76cb 100644
--- a/biometrics/face/aidl/android/hardware/biometrics/face/ISession.aidl
+++ b/biometrics/face/aidl/android/hardware/biometrics/face/ISession.aidl
@@ -178,6 +178,8 @@
* 2) A face is rejected, and ISessionCallback#onAuthenticationFailed is invoked.
* 3) Any non-recoverable error occurs (such as lockout). See the full list of
* authentication-specific errors in the Error enum.
+ * 4) ISessionCallback#onLockoutPermanent is invoked.
+ * 5) ISessionCallback#onLockoutTimed is invoked.
*
* Note that upon successful authentication, the lockout counter for this (sensorId, userId)
* pair must be cleared.
diff --git a/biometrics/face/aidl/android/hardware/biometrics/face/ISessionCallback.aidl b/biometrics/face/aidl/android/hardware/biometrics/face/ISessionCallback.aidl
index b3c348d..9eb575c 100644
--- a/biometrics/face/aidl/android/hardware/biometrics/face/ISessionCallback.aidl
+++ b/biometrics/face/aidl/android/hardware/biometrics/face/ISessionCallback.aidl
@@ -119,6 +119,8 @@
* lockout, and authentication can be restarted after a period of time. See
* ISession#resetLockout.
*
+ * This ends the authentication lifecycle.
+ *
* @param sensorId Sensor for which the user is locked out.
* @param userId User for which the sensor is locked out.
* @param durationMillis Remaining duration of the lockout.
@@ -131,6 +133,8 @@
* Authentication is disabled until the user unlocks with their device credential
* (PIN/Pattern/Password). See ISession#resetLockout.
*
+ * This ends the authentication lifecycle.
+ *
* @param sensorId Sensor for which the user is locked out.
* @param userId User for which the sensor is locked out.
*/