/*
* 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.keyguard;
public interface KeyguardSecurityCallback {
Dismiss the given security screen.
Params: - securityVerified – true if the user correctly entered credentials for the given screen.
- targetUserId – a user that needs to be the foreground user at the dismissal completion.
/**
* Dismiss the given security screen.
* @param securityVerified true if the user correctly entered credentials for the given screen.
* @param targetUserId a user that needs to be the foreground user at the dismissal completion.
*/
void dismiss(boolean securityVerified, int targetUserId);
Manually report user activity to keep the device awake.
/**
* Manually report user activity to keep the device awake.
*/
void userActivity();
Checks if keyguard is in "verify credentials" mode.
Returns: true if user has been asked to verify security.
/**
* Checks if keyguard is in "verify credentials" mode.
* @return true if user has been asked to verify security.
*/
boolean isVerifyUnlockOnly();
Call to report an unlock attempt.
Params: - userId – id of the user whose unlock attempt is recorded.
- success – set to 'true' if user correctly entered security credentials.
- timeoutMs – timeout in milliseconds to wait before reattempting an unlock.
Only nonzero if 'success' is false
/**
* Call to report an unlock attempt.
* @param userId id of the user whose unlock attempt is recorded.
* @param success set to 'true' if user correctly entered security credentials.
* @param timeoutMs timeout in milliseconds to wait before reattempting an unlock.
* Only nonzero if 'success' is false
*/
void reportUnlockAttempt(int userId, boolean success, int timeoutMs);
Resets the keyguard view.
/**
* Resets the keyguard view.
*/
void reset();
}