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 */
16package com.android.keyguard;
17
18public 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     */
24    void dismiss(boolean securityVerified);
25
26    /**
27     * Manually report user activity to keep the device awake.
28     */
29    void userActivity();
30
31    /**
32     * Checks if keyguard is in "verify credentials" mode.
33     * @return true if user has been asked to verify security.
34     */
35    boolean isVerifyUnlockOnly();
36
37    /**
38     * Call to report an unlock attempt.
39     * @param userId id of the user whose unlock attempt is recorded.
40     * @param success set to 'true' if user correctly entered security credentials.
41     * @param timeoutMs timeout in milliseconds to wait before reattempting an unlock.
42     *                  Only nonzero if 'success' is false
43     */
44    void reportUnlockAttempt(int userId, boolean success, int timeoutMs);
45
46    /**
47     * Resets the keyguard view.
48     */
49    void reset();
50}
51