platform_alexa_api_common_util/com.tomtom.ivi.platform.alexa.api.common.util

Package-level declarations

This package contains classes and functions which are intended for use by services or frontends that interact with the Alexa Voice Personal Assistant (VPA).

More specifically, the AacsSenderWrapper class and the utility functions in AlexaMessageData, such as parseAasbMessage or createAasbReplyHeader, should be used when implementing a com.tomtom.ivi.platform.alexa.api.service.alexahandler.AlexaHandlerService.

Types

AacsMessage

interface AacsMessage : Parcelable

An interface representing an AACS message.

AacsReplyMessage

data class AacsReplyMessage(val replyToId: String, val id: String, val topic: String, val action: String, val payload: String) : AacsMessage

Class representing an AACS reply message. A reply is the response to a previously received message.

AacsRequestMessage

data class AacsRequestMessage(val id: String, val topic: String, val action: String, val payload: String) : AacsMessage

Class representing an AACS request message. A request is a message which is not a reply to a previously received message. A request may or may not have a reply.

AacsSenderWrapper

class AacsSenderWrapper

A class that is used to send Alexa Auto Services Bridge (AASB) messages to the Alexa Auto Client Service (AACS). A service implementing the AlexaHandlerService should use this class to send requests/replies to the AACS.

ImageSource

@IviInternal

@Serializable

data class ImageSource(val url: String? = null, val darkBackgroundUrl: String? = null, val size: String? = null, val widthPixels: Long? = null, val heightPixels: Long? = null)

ImageSources

@IviInternal

typealias ImageSources = @Serializable List<ImageSource>

ImageStructure

@IviInternal

@Serializable

data class ImageStructure(val contentDescription: String? = null, val sources: ImageSources)

WarnIfMissingOrNull

@IviInternal

@Target(allowedTargets = [AnnotationTarget.FIELD])

annotation class WarnIfMissingOrNull

Annotation used to mark JSON fields that we allow to be null or missing, but for which we want to print a warning when that's the case.

Properties

ALEXA_COMMS_PHONE_ACCOUNT_ID

const val ALEXA_COMMS_PHONE_ACCOUNT_ID: String

This ID is used to select the AlexaComms self-managed phone account when registered.

Functions

buildJsonMessage

@IviExperimental(reasons = [])

inline fun <T> buildJsonMessage(message: T): String

Constructs a JSON string from the message of type T.

checkMissingOrNullFields

@IviInternal

fun Any.checkMissingOrNullFields()

excludePlaceholderUrl

@IviInternal

fun String.excludePlaceholderUrl(): String?

getAppropriateImageSourceOrNull

@IviInternal

fun ImageStructure?.getAppropriateImageSourceOrNull(): ImageSource?

parseEmbeddedIntent

@IviExperimental(reasons = [])

fun parseEmbeddedIntent(intent: Intent): AacsMessage?

Parses the intent to construct an AacsMessage object from it. Only embedded intents are parsable using this method.

parseJsonMessage

@IviExperimental(reasons = [])

inline fun <T : Any> parseJsonMessage(message: String): T?

Decodes the message in JSON format into an object of type T.

selectAppropriateImageSource

@IviInternal

fun ImageSources.selectAppropriateImageSource(): ImageSource?

withAasbIntentPrefix

@IviInternal

fun String.withAasbIntentPrefix(): String

Returns this string with the Alexa Auto Service Broker (AASB) prefix, resulting in the fully-qualified name of the android.content.Intent action or category.

withoutAasbIntentPrefix

@IviInternal

fun String.withoutAasbIntentPrefix(): String

Returns this string without the Alexa Auto Service Broker (AASB) prefix.