1 /* 2 * Copyright (C) 2023 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.android.systemui.keyguard.shared.model 18 19 import android.hardware.face.FaceManager 20 21 /** Authentication status provided by [com.android.keyguard.faceauth.KeyguardFaceAuthManager] */ 22 sealed class AuthenticationStatus 23 24 /** Success authentication status. */ 25 data class SuccessAuthenticationStatus(val successResult: FaceManager.AuthenticationResult) : 26 AuthenticationStatus() 27 28 /** Face authentication help message. */ 29 data class HelpAuthenticationStatus(val msgId: Int, val msg: String?) : AuthenticationStatus() 30 31 /** Face acquired message. */ 32 data class AcquiredAuthenticationStatus(val acquiredInfo: Int) : AuthenticationStatus() 33 34 /** Face authentication failed message. */ 35 object FailedAuthenticationStatus : AuthenticationStatus() 36 37 /** Face authentication error message */ 38 data class ErrorAuthenticationStatus(val msgId: Int, val msg: String?) : AuthenticationStatus() { 39 /** 40 * Method that checks if [msgId] is a lockout error. A lockout error means that face 41 * authentication is locked out. 42 */ isLockoutErrornull43 fun isLockoutError() = msgId == FaceManager.FACE_ERROR_LOCKOUT_PERMANENT 44 45 /** 46 * Method that checks if [msgId] is a cancellation error. This means that face authentication 47 * was cancelled before it completed. 48 */ 49 fun isCancellationError() = msgId == FaceManager.FACE_ERROR_CANCELED 50 } 51 52 /** Face detection success message. */ 53 data class DetectionStatus(val sensorId: Int, val userId: Int, val isStrongBiometric: Boolean) 54