1 /*
2  * Copyright (C) 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 com.android.intentresolver.shared.model
18 
19 import android.annotation.UserIdInt
20 import android.os.UserHandle
21 
22 /**
23  * A User represents the owner of a distinct set of content.
24  * * maps 1:1 to a UserHandle or UserId (Int) value.
25  * * refers to either [Full][Type.FULL], or a [Profile][Type.PROFILE] user, as indicated by the
26  *   [type] property.
27  *
28  * See
29  * [Users for system developers](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/os/Users.md)
30  *
31  * ```
32  * val users = listOf(
33  *     User(id = 0, role = PERSONAL),
34  *     User(id = 10, role = WORK),
35  *     User(id = 11, role = CLONE),
36  *     User(id = 12, role = PRIVATE),
37  * )
38  * ```
39  */
40 data class User(
41     @UserIdInt val id: Int,
42     val role: Role,
43 ) {
44     val handle: UserHandle = UserHandle.of(id)
45 
46     enum class Role {
47         PERSONAL,
48         PRIVATE,
49         WORK,
50         CLONE
51     }
52 }
53