api_appsuitedefaults_alexa/com.tomtom.ivi.appsuite.gradle.alexa.api.appsuitedefaults.alexa/IviDefaultsAlexaConfigPlugin

IviDefaultsAlexaConfigPlugin

class IviDefaultsAlexaConfigPlugin : IviDefaultsPlugin

Plugin to configure the Amazon Alexa voice assistant through a configuration provider.

Amazon requires IDs to be specified to configure a client to use Alexa. These are obtained from the part of Amazon's developer website dedicated to the Alexa Voice Service (AVS).

The behavior of this plugin is controlled by the flags disableAlexaDeviceIdBuildTimeCheck, alexaDeviceInfoClientId and alexaDeviceInfoProductId.

When both alexaDeviceInfoClientId and alexaDeviceInfoProductId are set to non-empty values, then their values are configured as the Alexa Voice Service (AVS) identifiers.
When one or neither of these properties are set, then the build will fail. The check that fails the build can be disabled by setting disableAlexaDeviceIdBuildTimeCheck to true.

For more information on exactly how to obtain the ID values and what they mean, refer to Amazon's documentation at: https://alexa.github.io/alexa-auto-sdk/docs/get-started/#register-an-avs-product

Plugin ID: com.tomtom.ivi.appsuite.alexa.defaults.config.

Constructors

IviDefaultsAlexaConfigPlugin

fun IviDefaultsAlexaConfigPlugin()

Types

Companion

object Companion

Functions

applyDefaults

open override fun IviDefaultsExtension.applyDefaults(project: Project)

Inherited functions

apply

override fun apply(project: Project)