xref: /frameworks/base/policy/src/com/android/internal/policy/impl/keyguard/KeyguardSecurityCallback.java

/*
 * Copyright (C) 2012 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.internal.policy.impl.keyguard;

public interface KeyguardSecurityCallback {

    /*package*/ interface OnDismissAction {

        /* returns true if the dismiss should be deferred */
        boolean onDismiss();
    }

    /**
     * Dismiss the given security screen.
     * @param securityVerified true if the user correctly entered credentials for the given screen.
     */
    void dismiss(boolean securityVerified);

    /**
     * Manually report user activity to keep the device awake. If timeout is 0,
     * uses user-defined timeout.
     * @param timeout
     */
    void userActivity(long timeout);

    /**
     * Checks if keyguard is in "verify credentials" mode.
     * @return true if user has been asked to verify security.
     */
    boolean isVerifyUnlockOnly();

    /**
     * Call when user correctly enters their credentials
     */
    void reportSuccessfulUnlockAttempt();

    /**
     * Call when the user incorrectly enters their credentials
     */
    void reportFailedUnlockAttempt();

    /**
     * Gets the number of attempts thus far as reported by {@link #reportFailedUnlockAttempt()}
     * @return number of failed attempts
     */
    int getFailedAttempts();

    /**
     * Shows the backup security for the current method.  If none available, this call is a no-op.
     */
    void showBackupSecurity();

    /**
     * Sets an action to perform after the user successfully enters their credentials.
     * @param action
     */
    void setOnDismissAction(OnDismissAction action);

}