platform_settings_api_service_userprofilemanagement/com.tomtom.ivi.platform.settings.api.service.userprofilemanagement/UserProfileManagementService

UserProfileManagementService

interface UserProfileManagementService
Content copied to clipboard

Service responsible for managing user profiles.

A user profile, created with createUserProfile, will be persistently stored, and loaded after the service restarts. The user profile may be updated with updateUserProfile or deleted with deleteUserProfile.

One of created user profiles must be set as active with activateUserProfile. The active user profile cannot be deleted.

Types

Link copied to clipboard
sealed class ActivateUserProfileResult : Parcelable
Content copied to clipboard

The result of activateUserProfile call.

Link copied to clipboard
object Companion
Content copied to clipboard
Link copied to clipboard
sealed class CreateUserProfileResult : Parcelable
Content copied to clipboard

The result of createUserProfile call.

Link copied to clipboard
sealed class DeleteUserProfileResult : Parcelable
Content copied to clipboard

The result of deleteUserProfile call.

Link copied to clipboard
sealed class UpdateUserProfileResult : Parcelable
Content copied to clipboard

The result of updateUserProfile call.

Properties

Link copied to clipboard
abstract val activeUserProfileId: Uid<UserProfile>
Content copied to clipboard

The ID of the active user profile. The user profiles details can be looked up in allUserProfiles.

Link copied to clipboard
abstract val allUserProfiles: MirrorableMap<Uid<UserProfile>, UserProfile>
Content copied to clipboard

Map of all created user profiles. It is updated when a new user profile is created, or the existing user profile is updated or deleted.

Functions

Link copied to clipboard
abstract suspend fun activateUserProfile(id: Uid<UserProfile>): UserProfileManagementService.ActivateUserProfileResult
Content copied to clipboard

Activates the user profile with id. If the user profile with id is already active then this call does nothing.

Link copied to clipboard
abstract suspend fun createUserProfile(displayName: String): UserProfileManagementService.CreateUserProfileResult
Content copied to clipboard

Creates a new user profile with displayName.

Link copied to clipboard
abstract suspend fun deleteUserProfile(id: Uid<UserProfile>): UserProfileManagementService.DeleteUserProfileResult
Content copied to clipboard

Deletes the user profile with id. The active user profile cannot be deleted.

Link copied to clipboard
abstract suspend fun updateUserProfile(userProfile: UserProfile): UserProfileManagementService.UpdateUserProfileResult
Content copied to clipboard

Updates the user profile with the ID of userProfile with values from userProfile. Note that ID cannot be changed with update.