1 /*
2  * Copyright (C) 2021 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 android.hardware.biometrics;
18 
19 import android.annotation.IntDef;
20 
21 import java.lang.annotation.Retention;
22 import java.lang.annotation.RetentionPolicy;
23 
24 /**
25  * Common constants for biometric overlays.
26  * @hide
27  */
28 public interface BiometricOverlayConstants {
29     /** Unknown usage. */
30     int REASON_UNKNOWN = 0;
31     /** User is about to enroll. */
32     int REASON_ENROLL_FIND_SENSOR = 1;
33     /** User is enrolling. */
34     int REASON_ENROLL_ENROLLING = 2;
35     /** Usage from BiometricPrompt. */
36     int REASON_AUTH_BP = 3;
37     /** Usage from Keyguard. */
38     int REASON_AUTH_KEYGUARD = 4;
39     /** Non-specific usage (from FingerprintManager). */
40     int REASON_AUTH_OTHER = 5;
41     /** Usage from Settings. */
42     int REASON_AUTH_SETTINGS = 6;
43 
44     @IntDef({REASON_UNKNOWN,
45             REASON_ENROLL_FIND_SENSOR,
46             REASON_ENROLL_ENROLLING,
47             REASON_AUTH_BP,
48             REASON_AUTH_KEYGUARD,
49             REASON_AUTH_OTHER,
50             REASON_AUTH_SETTINGS})
51     @Retention(RetentionPolicy.SOURCE)
52     @interface ShowReason {}
53 }
54