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 requests. 26 * @hide 27 */ 28 public class BiometricRequestConstants { 29 BiometricRequestConstants()30 private BiometricRequestConstants() {} 31 32 /** Unknown usage. */ 33 public static final int REASON_UNKNOWN = 0; 34 /** User is about to enroll. */ 35 public static final int REASON_ENROLL_FIND_SENSOR = 1; 36 /** User is enrolling. */ 37 public static final int REASON_ENROLL_ENROLLING = 2; 38 /** Usage from BiometricPrompt. */ 39 public static final int REASON_AUTH_BP = 3; 40 /** Usage from Device Entry. */ 41 public static final int REASON_AUTH_KEYGUARD = 4; 42 /** Non-specific usage (from FingerprintManager). */ 43 public static final int REASON_AUTH_OTHER = 5; 44 /** Usage from Settings. */ 45 public static final int REASON_AUTH_SETTINGS = 6; 46 47 @IntDef({REASON_UNKNOWN, 48 REASON_ENROLL_FIND_SENSOR, 49 REASON_ENROLL_ENROLLING, 50 REASON_AUTH_BP, 51 REASON_AUTH_KEYGUARD, 52 REASON_AUTH_OTHER, 53 REASON_AUTH_SETTINGS}) 54 @Retention(RetentionPolicy.SOURCE) 55 public @interface RequestReason {} 56 } 57