1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
/*
* Copyright (C) 2020 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.systemui.settings
import android.content.Context
import android.content.pm.UserInfo
import android.os.UserHandle
import java.util.concurrent.CountDownLatch
import java.util.concurrent.Executor
/**
* User tracker for SystemUI.
*
* This tracker provides async access to current user information, as well as callbacks for
* user/profile change.
*/
interface UserTracker : UserContentResolverProvider, UserContextProvider {
/**
* Current user's id.
*/
val userId: Int
/**
* [UserHandle] for current user
*/
val userHandle: UserHandle
/**
* [UserInfo] for current user
*/
val userInfo: UserInfo
/**
* List of profiles associated with the current user.
*
* Quiet work profiles will still appear here, but will have the `QUIET_MODE` flag.
*/
val userProfiles: List<UserInfo>
/**
* Add a [Callback] to be notified of chances, on a particular [Executor]
*/
fun addCallback(callback: Callback, executor: Executor)
/**
* Remove a [Callback] previously added.
*/
fun removeCallback(callback: Callback)
/**
* Callback for notifying of changes.
*/
interface Callback {
/**
* Same as {@link onUserChanging(Int, Context, CountDownLatch)} but the latch will be
* auto-decremented after the completion of this method.
*/
@JvmDefault
fun onUserChanging(newUser: Int, userContext: Context) {}
/**
* Notifies that the current user is being changed.
* Override this method to run things while the screen is frozen for the user switch.
* Please use {@link #onUserChanged} if the task doesn't need to push the unfreezing of the
* screen further. Please be aware that code executed in this callback will lengthen the
* user switch duration. When overriding this method, countDown() MUST be called on the
* latch once execution is complete.
*/
@JvmDefault
fun onUserChanging(newUser: Int, userContext: Context, latch: CountDownLatch) {
onUserChanging(newUser, userContext)
latch.countDown()
}
/**
* Notifies that the current user has changed.
* Override this method to run things after the screen is unfrozen for the user switch.
* Please see {@link #onUserChanging} if you need to hide jank.
*/
@JvmDefault
fun onUserChanged(newUser: Int, userContext: Context) {}
/**
* Notifies that the current user's profiles have changed.
*/
@JvmDefault
fun onProfilesChanged(profiles: List<@JvmSuppressWildcards UserInfo>) {}
}
}
|
