platform_localization_api_common_settings/com.tomtom.ivi.platform.localization.api.common.settings

Package-level declarations

This package contains tools for customising the region-specific elements of the TomTom Digital Cockpit environment such as language.

setSystemLocale is an API which allows for changing the Android system's language, reflected in all apps present on the system.

Types

TimeFormat

@IviExperimental(reasons = [])

enum TimeFormat : Enum<TimeFormat>

Represents the different formats in which clock time can be displayed. TimeFormat.CLOCK_12H represents clock time that runs from 1am to noon and then from 1pm to midnight. TimeFormat.CLOCK_24H represents clock time that runs from 00:00 (midnight) to 23:59. TimeFormat.UNSET is a special value used to signal that no configuration has been set for the clock time format.

Functions

getClockTimeFormat

@IviExperimental(reasons = [])

fun getClockTimeFormat(context: Context): TimeFormat

Retrieves the current clock time format value at Settings.System.TIME_12_24 and returns the corresponding TimeFormat enum value.

restartActivity

@IviExperimental(reasons = [])

fun Context.restartActivity()

Extends Context to restart the Activity.

setClockTimeFormat

@IviExperimental(reasons = [])

fun setClockTimeFormat(context: Context, timeFormat: TimeFormat)

Sets Settings.System.TIME_12_24 to the time format setting determined by the timeValue parameter. This API Requires android.permission.WRITE_PERMISSIONS.

setSystemLocale

@IviExperimental(reasons = [])

fun setSystemLocale(locale: Locale)

Sets locale as the Android System Locale. This can be used to switch language on the Android system level. The android.permission.CHANGE_CONFIGURATION permission is required in order to use this API.