AlexaSettingsService

interface AlexaSettingsService

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val activeLocales: String

Setting value defining the locale used by Alexa. It can be a single locale or pair of locales since Alexa supports multi-locale mode. Stored as an IETF BCP 47 language tag (for example, "en-US" or "en-US/de-DE"). Valid values are: "en-US", "es-US", "de-DE", "en-AU", "en-CA", "en-GB", "en-IN", "es-ES", "es-MX", "fr-CA", "fr-FR", "hi-IN", "it-IT", "ja-JP", "pt-BR", "en-US/es-US", "es-US/en-US", "en-IN/hi-IN", "hi-IN/en-IN", "en-CA/fr-CA", "fr-CA/en-CA", "en-US/es-ES", "es-ES/en-US", "en-US/de-DE", "de-DE/en-US", "en-US/fr-FR", "fr-FR/en-US", "en-US/it-IT", "it-IT/en-US", "en-US/ja-JP", "ja-JP/en-US".

Link copied to clipboard
abstract val alerts: List<VpaAlert>

Setting value defining the states of Alexa alerts as a list of VpaAlert objects.

Link copied to clipboard
abstract val allowedPersonalData: Map<BluetoothDeviceAddress, EnumSet<PersonalDataType>>

Setting value defining the set of personal data types, stored on a phone, that the user has allowed to be sent to the VPA.

Link copied to clipboard
abstract val authorizationData: AuthorizationData

The set of data that is used to authenticate with the Alexa service. This is stored as key-value pairs, corresponding to the key and data fields in the Alexa AuthorizationSetAuthorizationData message.

Link copied to clipboard
abstract val doNotDisturbModeEnabled: Boolean

Setting value defining whether do not disturb mode is enabled.

Link copied to clipboard
abstract val enabledEarcons: EnumSet<VpaEarconType>

Setting value defining the enabled earcons.

Link copied to clipboard
abstract val locationSharingEnabled: Boolean

Setting value defining whether location sharing is enabled.

Link copied to clipboard
abstract val privacyModeEnabled: Boolean

Setting value defining whether privacy mode is enabled. When enabled, Alexa AACS service will be stopped, so the user cannot invoke Alexa and Alexa will not proactively start a conversation or send any notifications to the user. The frontend should accompany this by disabling all Alexa-related screens (such as Settings) and UI controls (such as 'push-to-talk' if present). This can be used in restricted modes such as valet or for guest drivers. When privacy mode is enabled all Alexa functionalities will be disabled (even Alexa TTS).

Link copied to clipboard
abstract val syncNavigationFavoritesEnabled: Boolean

Setting value defining whether syncing navigation favorites is enabled.

Link copied to clipboard
abstract val wakeUpWordEnabled: Boolean

Setting value defining whether Wake Up Word detection is enabled.