1 /*
2  * Copyright (C) 2022 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  */
16 package com.android.systemui.smartspace
17 
18 import android.app.smartspace.SmartspaceTarget
19 
20 /**
21  * {@link SmartspaceTargetFilter} defines a way to locally filter targets from inclusion. This
22  * should be used for filtering that isn't available further upstream.
23  */
24 interface SmartspaceTargetFilter {
25     /**
26      * An interface implemented by clients to receive updates when the filtering criteria changes.
27      * When this happens, the client should refresh their target set.
28      */
29     interface Listener {
30         fun onCriteriaChanged()
31     }
32 
33     /**
34      * Adds a listener to receive future updates. {@link Listener#onCriteriaChanged} will be
35      * invoked immediately after.
36      */
37     fun addListener(listener: Listener)
38 
39     /**
40      * Removes listener from receiving future updates.
41      */
42     fun removeListener(listener: Listener)
43 
44     /**
45      * Returns {@code true} if the {@link SmartspaceTarget} should be included in the current
46      * target set, {@code false} otherwise.
47      */
48     fun filterSmartspaceTarget(t: SmartspaceTarget): Boolean
49 }