VpaAdaptationService

The active Template to render or null if there is no Template to render.

The state of the VPA's alerts.

The state of the conversation with the VPA. This helps a UI indicate whether, for example, the VPA is waiting for the user to reply to a question.

True if the VPA has notifications which are available to be retrieved, false otherwise.

The status of the authentication process for this VPA.

Indicates whether this VPA is ready for use by clients. An VpaAvailabilityState.AVAILABLE VPA should provide valid data as results when its other properties such as vpaAuthenticationStatus, vpaSettings, dialogueState are accessed. This VPA should not be in the VpaAvailabilityState.AVAILABLE state if it cannot provide valid results when these properties are queried. It should also not set itself to this state if it is, for example, busy initializing itself or in an erroneous state which prevents it from being used for any API call.

Information relating to this VPA.

The current settings for this VPA.

Enables or disables "Do Not Disturb" mode with this VPA. When enabled, all incoming notifications, announcements etc. are blocked, except for high priority ones such as alarms and timers.

Enables or disables the earcon of type earconType. An earcon sound will be played only if its corresponding VpaEarconType is enabled.

Enables or disable location sharing with this VPA. If location sharing is enabled, the vehicle's current location is shared with this VPA to, for example, get smarter responses for nearby restaurants, local weather, navigation requests and more.

Enable Privacy mode for this VPA.

Enables or disables synchronization of the vehicle navigation favorites with this VPA. When enabled, the VPA will be informed of the user's favorite addresses (for example, Home or Work).

Asks the VPA to enable or disable Wake Up Word detection.

Request to authenticate with this VPA service, if it is necessary to access this VPAs functionality. The result of the authentication request can be monitored by observing the vpaAuthenticationStatus.

Logs the end-user out of the VPA service, if they were previously logged in. The result of this process can be monitored by observing the vpaAuthenticationStatus.

Notifies the VPA that the UI component visualizing the active template has been removed.

Notifies the VPA that a custom UI event occurred.

Asks the VPA to clear all active and pending alerts.

Asks the VPA to start listening for audio. This should be called, for example, when the user wants to speak to the VPA and has indicated this by pressing a push-to-talk button.

Asks the VPA to stop all the active alerts.

Asks the VPA to stop the current interaction (if any) and go back to its idle state.

Asks the VPA to update the active locales. These are the languages that will be spoken and recognized by the VPA.

Updates the set of personal data types that the user has allowed to be sent to this VPA service. The VPA could typically use this information to, for example, recognise contact names for hands free calling and to read messages aloud.