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.biometrics.shared.model
18 
19 /**
20  * The logical reason for a fingerprint auth operation if one is on-going, otherwise [NotRunning].
21  */
22 sealed interface AuthenticationReason {
23     /** Device entry requested authentication */
24     data object DeviceEntryAuthentication : AuthenticationReason
25 
26     /** Settings requested authentication */
27     data class SettingsAuthentication(val settingsOperation: SettingsOperations) :
28         AuthenticationReason
29 
30     /** App requested authentication */
31     data object BiometricPromptAuthentication : AuthenticationReason
32 
33     /** Authentication requested for other reason */
34     data object OtherAuthentication : AuthenticationReason
35 
36     /** Authentication requested for unknown reason */
37     data object Unknown : AuthenticationReason
38 
39     /** Authentication is not running */
40     data object NotRunning : AuthenticationReason
41 
42     /** Settings operations that request biometric authentication */
43     enum class SettingsOperations {
44         ENROLL_ENROLLING,
45         ENROLL_FIND_SENSOR,
46         OTHER
47     }
48 }
49