1 /*
2  * Copyright (C) 2024 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.settings.biometrics.fingerprint.feature
18 
19 import android.content.Context
20 import android.view.View
21 import androidx.preference.Preference
22 
23 /**
24  * Defines the feature provided by rest to unlock.
25  */
26 interface SfpsRestToUnlockFeature {
27     /**
28      * Gets the content view hierarchy for SFPS rest to unlock feature which is used by
29      * [com.android.settings.biometrics.fingerprint.FingerprintEnrollFinish].
30      * @param context the context of
31      * [com.android.settings.biometrics.fingerprint.FingerprintEnrollFinish].
32      */
getRestToUnlockLayoutnull33     fun getRestToUnlockLayout(context: Context) : View? = null
34 
35     /**
36      * Gets the SFPS rest to unlock preference which is used in
37      * [com.android.settings.biometrics.fingerprint.FingerprintSettings].
38      * @param context the context of
39      * [com.android.settings.biometrics.fingerprint.FingerprintSettings].
40      */
41     fun getRestToUnlockPreference(context: Context) : Preference? = null
42 
43     /**
44      * Gets the specific description used in
45      * [com.android.settings.biometrics.fingerprint.FingerprintEnrollFinish] for SFPS devices.
46      * @return the description text for SFPS devices.
47      */
48     fun getDescriptionForSfps(context: Context) : String
49 }