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 */ 16 package com.android.keyguard; 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. 23 * @param targetUserId a user that needs to be the foreground user at the dismissal completion. 24 */ dismiss(boolean securityVerified, int targetUserId)25 void dismiss(boolean securityVerified, int targetUserId); 26 27 /** 28 * Dismiss the given security screen. 29 * @param securityVerified true if the user correctly entered credentials for the given screen. 30 * @param targetUserId a user that needs to be the foreground user at the dismissal completion. 31 * @param bypassSecondaryLockScreen true if the user can bypass the secondary lock screen, 32 * if any, during this dismissal. 33 */ dismiss(boolean securityVerified, int targetUserId, boolean bypassSecondaryLockScreen)34 void dismiss(boolean securityVerified, int targetUserId, boolean bypassSecondaryLockScreen); 35 36 /** 37 * Manually report user activity to keep the device awake. 38 */ userActivity()39 void userActivity(); 40 41 /** 42 * Checks if keyguard is in "verify credentials" mode. 43 * @return true if user has been asked to verify security. 44 */ isVerifyUnlockOnly()45 boolean isVerifyUnlockOnly(); 46 47 /** 48 * Call to report an unlock attempt. 49 * @param userId id of the user whose unlock attempt is recorded. 50 * @param success set to 'true' if user correctly entered security credentials. 51 * @param timeoutMs timeout in milliseconds to wait before reattempting an unlock. 52 * Only nonzero if 'success' is false 53 */ reportUnlockAttempt(int userId, boolean success, int timeoutMs)54 void reportUnlockAttempt(int userId, boolean success, int timeoutMs); 55 56 /** 57 * Resets the keyguard view. 58 */ reset()59 void reset(); 60 61 /** 62 * Call when cancel button is pressed in bouncer. 63 */ onCancelClicked()64 default void onCancelClicked() { 65 // No-op 66 } 67 68 /** 69 * Invoked whenever users are typing their password or drawing a pattern. 70 */ onUserInput()71 void onUserInput(); 72 } 73