platform_settings_api_service_settingsmanagement/com.tomtom.ivi.platform.settings.api.service.settingsmanagement

Package-level declarations

Contains the API to manage settings.

Types

BooleanListSettingKey

data class BooleanListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<Boolean> type.

BooleanSettingKey

data class BooleanSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a Boolean type.

DoubleListSettingKey

data class DoubleListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<Double> type.

DoubleSettingKey

data class DoubleSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a Double type.

EnumSettingKey

data class EnumSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of any Enum type.

FloatListSettingKey

data class FloatListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<Float> type.

FloatSettingKey

data class FloatSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a Float type.

IntListSettingKey

data class IntListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<Int> type.

IntSettingKey

data class IntSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of an Int type.

LongListSettingKey

data class LongListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<Long> type.

LongSettingKey

data class LongSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a Long type.

SettingKey

sealed class SettingKey : Parcelable

A key used to refer to a setting of a certain type and a scope.

SettingScope

enum SettingScope : Enum<SettingScope> , Parcelable

Specifies a scope in which the setting is being used.

SettingsManagementService

interface SettingsManagementService

Service responsible for managing settings. SettingScope defines two types of settings:

SettingsManagementSessionToken

data class SettingsManagementSessionToken(val token: Uid<SettingsManagementSessionToken>) : Parcelable

A session token identifies the state of settings visible to clients of SettingsManagementService.

SettingUpdateStrategy

enum SettingUpdateStrategy : Enum<SettingUpdateStrategy> , Parcelable

A strategy that specifies what happens to the existing setting values after changing the default value.

StringListSettingKey

data class StringListSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a List<String> type.

StringSettingKey

data class StringSettingKey(val scope: SettingScope, val id: String) : SettingKey

A key used to refer to a setting of a String type.