1 /*
2  * Copyright (C) 2023 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 
17 package com.android.systemui.qs.pipeline.domain.model
18 
19 import kotlinx.coroutines.flow.Flow
20 
21 /**
22  * Tracks conditions for auto-adding or removing specific tiles.
23  *
24  * When creating a new [AutoAddable], it needs to be registered in a [Module] like
25  * [BaseAutoAddableModule], for example:
26  * ```
27  * @Binds
28  * @IntoSet
29  * fun providesMyAutoAddable(autoAddable: MyAutoAddable): AutoAddable
30  * ```
31  */
32 interface AutoAddable {
33 
34     /**
35      * Signals associated with a particular user indicating whether a particular tile needs to be
36      * auto-added or auto-removed.
37      */
38     fun autoAddSignal(userId: Int): Flow<AutoAddSignal>
39 
40     /**
41      * Lifecycle for this object. It indicates in which cases [autoAddSignal] should be collected
42      */
43     val autoAddTracking: AutoAddTracking
44 
45     /** Human readable description */
46     val description: String
47 }
48