platform_vpa_api_common_vpa/com.tomtom.ivi.platform.vpa.api.common.vpa

Package-level declarations

This package contains data classes representing VPA information. It can be used for implementing a custom com.tomtom.ivi.platform.vpa.api.service.vpaadaptation.VpaAdaptationService or in a frontend interacting with the com.tomtom.ivi.platform.vpa.api.service.vpamediator.VpaMediatorService.

Types

AuthenticationError

enum AuthenticationError : Enum<AuthenticationError>

Error codes explaining what went wrong when attempting to authenticate with a VPA.

AuthenticationInfo

data class AuthenticationInfo(val url: String?, val authenticationCode: String?) : Parcelable

Holds data that informs the client about how to authenticate with the VPA service.

AuthenticationState

enum AuthenticationState : Enum<AuthenticationState>

The different authentication states the VPA service can be in.

AuthenticationType

enum AuthenticationType : Enum<AuthenticationType> , Parcelable

The mechanism to use to authenticate the end-user with a VPA service.

BluetoothAddressToAllowedPersonalDataMap

@IviExperimental(reasons = [IviExperimentalReason.EXPOSES_EXPERIMENTAL_TYPE])

typealias BluetoothAddressToAllowedPersonalDataMap = Map<BluetoothDeviceAddress, EnumSet<PersonalDataType>>

A Map that associates each paired Bluetooth device to the set of personal data types stored on it that the user has allowed to be sent to a VPA.

CallAction

data class CallAction(val phoneNumber: String) : VpaAction

VpaAction that places a phone call.

DialogueState

enum DialogueState : Enum<DialogueState>

The state of the verbal conversation between the end-user and the VPA.

LocaleCombination

typealias LocaleCombination = List<Locale>

Describes a combination of Locales that may be supported by a VPA. The list is sorted by order of priority given to the languages by the VPA.

NavigateAction

@IviExperimental(reasons = [])

data class NavigateAction(val place: Place) : VpaAction

VpaAction that navigates to a location specified by the place.

PersonalDataType

enum PersonalDataType : Enum<PersonalDataType> , Parcelable

The types of personal data, stored on a phone, that can be shared with a VPA.

Template

data class Template(val version: TemplateVersion, val data: VpaMessage) : Parcelable

Templates are visual metadata that can be provided by a VPA as a result of certain requests. The UI can show this data in order to describe or enhance a user's voice interaction.

TemplateVersion

typealias TemplateVersion = Int

VpaAction

abstract class VpaAction(val shouldHideVpaUi: Boolean) : Parcelable

VPA action requests initiated by user interaction and consumed by a VpaActionsService.

VpaAlert

data class VpaAlert(val alertId: String, val reason: String?, val state: VpaAlertState, val time: String?, val type: VpaAlertType?, val label: String?) : Parcelable

Holds information about an alert that has been scheduled through interaction with a VPA. For example, the user might have asked the VPA to schedule an alarm or create a reminder.

VpaAlertState

enum VpaAlertState : Enum<VpaAlertState>

The state of a VpaAlert, indicating whether it's waiting to be triggered, it's currently being triggered or it's no longer triggered.

VpaAlertType

enum VpaAlertType : Enum<VpaAlertType>

The type of a VpaAlert.

VpaAuthenticationStatus

data class VpaAuthenticationStatus(val authenticationState: AuthenticationState, val authenticationType: AuthenticationType? = null, val authenticationInfo: AuthenticationInfo? = null, val lastAuthenticationError: AuthenticationError? = null) : Parcelable

Holds all the information about the VPA authentication process.

VpaAvailabilityState

@IviExperimental(reasons = [])

enum VpaAvailabilityState : Enum<VpaAvailabilityState>

Describes whether a VPA is available to clients for use. When a VPA is available, clients can make API calls to it. This does not necessarily mean that the end-user can speak to the VPA yet.

VpaEarconType

enum VpaEarconType : Enum<VpaEarconType> , Parcelable

The different earcon types that can be played when a VPA changes state.

VpaIdentifier

data class VpaIdentifier(val name: String) : Parcelable

A name used for uniquely identifying a particular VPA. It is not localized and should not be used for display in a production UI.

VpaMessage

data class VpaMessage(val topic: String, val action: String, val payload: String) : Parcelable

A class that can be used to exchange custom data between a VPA service and its clients.

VpaProperties

data class VpaProperties(val vpaIdentifier: VpaIdentifier, val supportedLocales: List<Locale>, val supportedLocaleCombinations: List<LocaleCombination>? = null, val supportedCountries: List<String>) : Parcelable

Holds information about immutable properties of a VPA, such as its name or the list of languages it supports.

VpaSettings

data class VpaSettings(val wakeUpWordEnabled: Boolean, val activeLocales: List<Locale>, val enabledEarcons: EnumSet<VpaEarconType>, val doNotDisturbModeEnabled: Boolean, val locationSharingEnabled: Boolean, val syncVehicleNavigationFavoritesEnabled: Boolean, val allowedPersonalData: BluetoothAddressToAllowedPersonalDataMap = emptyMap()) : Parcelable

Holds the current state of all the settings for a VPA.

VpaUiVisibilityState

enum VpaUiVisibilityState : Enum<VpaUiVisibilityState>

The required visibility of the VPA panel.