KeyguardSecurityCallback.java revision 258341c377b6aa9f1bd29a9b507a97967e432dfe 
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.internal.policy.impl.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. If timeout is 0,
28     * uses user-defined timeout.
29     * @param timeout
30     */
31    void userActivity(long timeout);
32
33    /**
34     * Checks if keyguard is in "verify credentials" mode.
35     * @return true if user has been asked to verify security.
36     */
37    boolean isVerifyUnlockOnly();
38
39    /**
40     * Call when user correctly enters their credentials
41     */
42    void reportSuccessfulUnlockAttempt();
43
44    /**
45     * Call when the user incorrectly enters their credentials
46     */
47    void reportFailedUnlockAttempt();
48
49    /**
50     * Gets the number of attempts thus far as reported by {@link #reportFailedUnlockAttempt()}
51     * @return number of failed attempts
52     */
53    int getFailedAttempts();
54
55    /**
56     * Shows the backup security for the current method.  If none available, this call is a no-op.
57     */
58    void showBackupSecurity();
59
60    /**
61     * Sets a runnable to launch after the user successfully enters their credentials.
62     * @param runnable
63     */
64    void setOnDismissRunnable(Runnable runnable);
65
66}
67