Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 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 | */ |
Jim Miller | 5ecd811 | 2013-01-09 18:50:26 -0800 | [diff] [blame] | 16 | package com.android.keyguard; |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 17 | |
| 18 | public interface KeyguardSecurityCallback { |
| 19 | |
| 20 | /** |
| 21 | * Dismiss the given security screen. |
| 22 | * @param securityVerified true if the user correctly entered credentials for the given screen. |
Vadim Tryshev | 8702ca7 | 2016-04-22 08:14:12 -0700 | [diff] [blame] | 23 | * @param targetUserId a user that needs to be the foreground user at the dismissal completion. |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 24 | */ |
Vadim Tryshev | 8702ca7 | 2016-04-22 08:14:12 -0700 | [diff] [blame] | 25 | void dismiss(boolean securityVerified, int targetUserId); |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 26 | |
| 27 | /** |
Jorim Jaggi | b690f0d | 2014-07-03 23:25:44 +0200 | [diff] [blame] | 28 | * Manually report user activity to keep the device awake. |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 29 | */ |
Jorim Jaggi | b690f0d | 2014-07-03 23:25:44 +0200 | [diff] [blame] | 30 | void userActivity(); |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 31 | |
| 32 | /** |
| 33 | * Checks if keyguard is in "verify credentials" mode. |
| 34 | * @return true if user has been asked to verify security. |
| 35 | */ |
| 36 | boolean isVerifyUnlockOnly(); |
| 37 | |
| 38 | /** |
Jim Miller | 5a8daad | 2014-01-14 18:57:03 -0800 | [diff] [blame] | 39 | * Call to report an unlock attempt. |
Xiyuan Xia | ce64cea | 2016-01-06 08:51:16 -0800 | [diff] [blame] | 40 | * @param userId id of the user whose unlock attempt is recorded. |
Jim Miller | 5a8daad | 2014-01-14 18:57:03 -0800 | [diff] [blame] | 41 | * @param success set to 'true' if user correctly entered security credentials. |
Andres Morales | 2397427 | 2015-05-14 22:42:26 -0700 | [diff] [blame] | 42 | * @param timeoutMs timeout in milliseconds to wait before reattempting an unlock. |
| 43 | * Only nonzero if 'success' is false |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 44 | */ |
Xiyuan Xia | ce64cea | 2016-01-06 08:51:16 -0800 | [diff] [blame] | 45 | void reportUnlockAttempt(int userId, boolean success, int timeoutMs); |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 46 | |
Andrew Lee | 72b46d4 | 2015-01-30 13:23:21 -0800 | [diff] [blame] | 47 | /** |
| 48 | * Resets the keyguard view. |
| 49 | */ |
| 50 | void reset(); |
Aarthi Balachander | 0a427ef | 2018-07-13 15:00:58 -0700 | [diff] [blame] | 51 | |
| 52 | /** |
| 53 | * Call when cancel button is pressed in bouncer. |
| 54 | */ |
| 55 | default void onCancelClicked() { |
| 56 | // No-op |
| 57 | } |
Jim Miller | dcb3d84 | 2012-08-23 19:18:12 -0700 | [diff] [blame] | 58 | } |