/*
 * Copyright (C) 2024 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.intentresolver.shared.model

import android.annotation.UserIdInt
import android.os.UserHandle

/**
 * A User represents the owner of a distinct set of content.
 * * maps 1:1 to a UserHandle or UserId (Int) value.
 * * refers to either [Full][Type.FULL], or a [Profile][Type.PROFILE] user, as indicated by the
 *   [type] property.
 *
 * See
 * [Users for system developers](https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/os/Users.md)
 *
 * ```
 * val users = listOf(
 *     User(id = 0, role = PERSONAL),
 *     User(id = 10, role = WORK),
 *     User(id = 11, role = CLONE),
 *     User(id = 12, role = PRIVATE),
 * )
 * ```
 */
data class User(
    @UserIdInt val id: Int,
    val role: Role,
) {
    val handle: UserHandle = UserHandle.of(id)

    enum class Role {
        PERSONAL,
        PRIVATE,
        WORK,
        CLONE
    }
}