platform_users_api_service_users/com.tomtom.ivi.platform.users.api.service.users/UserService

UserService

@IviExperimental(reasons = [])
interface UserService

Service responsible for managing user profiles.

User profiles are managed by the Operating System.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
sealed class CreateUserResult : Parcelable

The result of a createUser call.

Link copied to clipboard
sealed class DeleteUserResult : Parcelable

The result of a deleteUser call.

Link copied to clipboard
sealed class EditUserResult : Parcelable

The result of an editUser call.

Link copied to clipboard
sealed class SetPinResult : Parcelable

The result of a setPin call.

Link copied to clipboard
sealed class SwitchToUserResult : Parcelable

The result of a switchToUser call.

Properties

Link copied to clipboard
abstract val activeUser: User

The currently logged in User.

Link copied to clipboard
abstract val isConfigurationModeEnabled: Boolean

Indicates if the configuration mode is currently enabled.

Link copied to clipboard
abstract val maxSupportedUsers: Int

Maximum number of users supported by the system.

Link copied to clipboard
abstract val users: List<User>

A list of all users registered in the system.

Functions

Link copied to clipboard
abstract suspend fun createUser(user: User): UserService.CreateUserResult

Creates a new user profile using details contained in the provided User object.

Link copied to clipboard
abstract suspend fun deleteUser(user: User): UserService.DeleteUserResult

Remove a user from the system.

Link copied to clipboard
abstract suspend fun disableConfigurationMode()

Disables configuration mode by setting isConfigurationModeEnabled to false.

Link copied to clipboard
abstract suspend fun editUser(user: User): UserService.EditUserResult

Change the details of the activeUser with the details given in user.

Link copied to clipboard
abstract suspend fun enableConfigurationMode()

Enables configuration mode by setting isConfigurationModeEnabled to true.

Link copied to clipboard
abstract suspend fun setPin(newPin: UserPin): UserService.SetPinResult

Secure the current user profile with the given newPin.

Link copied to clipboard
abstract suspend fun switchToUser(user: User): UserService.SwitchToUserResult

Called to activate the specified user.