1 /*
2  * Copyright 2024 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 androidx.privacysandbox.ui.provider
18 
19 import androidx.privacysandbox.ui.core.SessionObserver
20 import androidx.privacysandbox.ui.core.SessionObserverFactory
21 
22 interface SessionObserverFactoryRegistry {
23 
24     val sessionObserverFactories: List<SessionObserverFactory>
25 
26     /**
27      * Adds a [SessionObserverFactory] for tracking UI presentation state across UI sessions. This
28      * has no effect on already open sessions.
29      *
30      * For each session that is created for the adapter after this call returns,
31      * [SessionObserverFactory.create] will be invoked to allow a new [SessionObserver] instance to
32      * be attached to the UI session. This [SessionObserver] will receive UI updates for the
33      * lifetime of the session. A separate [SessionObserverFactory.create] call will be made for
34      * each UI session.
35      */
addObserverFactorynull36     fun addObserverFactory(sessionObserverFactory: SessionObserverFactory)
37 
38     /**
39      * Removes a [SessionObserverFactory], if it has been previously added with
40      * [addObserverFactory].
41      *
42      * If the [SessionObserverFactory] was not previously added, no action is performed. Any
43      * existing [SessionObserver] instances that have been created by the [SessionObserverFactory]
44      * will continue to receive updates until their corresponding UI session has been closed. For
45      * any subsequent sessions created], no call to [SessionObserverFactory.create] will be made.
46      */
47     fun removeObserverFactory(sessionObserverFactory: SessionObserverFactory)
48 }
49