libs/WindowManager/Shell/src/com/android/wm/shell/compatui/CompatUI.java

/*
 * Copyright (C) 2021 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.wm.shell.compatui;

import com.android.wm.shell.common.annotations.ExternalThread;

/**
 * Interface to engage compat UI.
 */
@ExternalThread
public interface CompatUI {
    /**
     * Called when the keyguard showing state changes. Removes all compat UIs if the
     * keyguard is now showing.
     *
     * <p>Note that if the keyguard is occluded it will also be considered showing.
     *
     * @param showing indicates if the keyguard is now showing.
     */
    void onKeyguardShowingChanged(boolean showing);
}