appsuite_alexa_api_common_apl/com.tomtom.ivi.appsuite.alexa.api.common.apl/AplEventHandler

AplEventHandler

@IviExperimental(message = "This API is experimental and relies on the Alexa Auto APL feature, which is not fully mature yet. It may change in the future without providing backward compatibility.", reasons = [])

class AplEventHandler(layout: APLLayout, context: Context)

This class provides the functionality to handle AACS Alexa Presentation Language (APL) events.

Note: The application is required to initialize the APL runtime by passing the Android context to initialize prior to the inflation of APLLayout components.

Parameters

layout

The layout of the screen on which the APL document is rendered. See Amazon Documentation for details.

context

The Context that the layout is associated with.

Constructors

AplEventHandler

constructor(layout: APLLayout, context: Context)

Types

object Companion

Properties

val aplVpaMessage: LiveData<VpaMessage>

It keeps the info about the latest APL VPA message generated by AplEventSender which will be sent back to AACS.

Functions

handleAplDirective

fun handleAplDirective(message: VpaMessage)

Processes instructions provided by the APL Directive in the message.

fun removeLayout()

It clears the map of APL layouts. To avoid memory leaks, this function should be called when the fragment rendering the APL documents is destroyed.

setDisallowVideo

fun setDisallowVideo(disallowVideo: Boolean)

Sets the Disallow Video APL Runtime Property.

setDrivingState

fun setDrivingState(drivingState: AplDrivingState)

Sets the Driving State APL Runtime Property.

fun setTheme(theme: String)

Sets the Theme APL Runtime Property.