IviDefaultsAutomotiveUiConfigPlugin

class IviDefaultsAutomotiveUiConfigPlugin : IviDefaultsPlugin

Plugin to configure Automotive UI API key and Onboard Map through a configuration provider.

The behavior of this plugin is controlled by the automotiveUiApiKey and useInternalAutomotiveUiApiKey:

  • When automotiveUiApiKey property value is not empty, then this property value is configured as the Automotive UI API key.

  • When useInternalAutomotiveUiApiKey property is set to true, then the TomTom-internal Automotive UI API key is configured.

  • When both properties are set, then the automotiveUiApiKey property takes precedence and the useInternalAutomotiveUiApiKey property is ignored.

  • When both properties are not set, then the build fails. This can be disabled by setting the disableAutomotiveUiApiKeyBuildTimeCheck property to true.

The Automotive UI Onboard Map configured by the following attributes:

  • When automotiveUiOnboardMapPathKey property is not empty, then it overrides the default path to the TomTom Automotive UI onboard map.

  • When automotiveUiOnboardMapKeystorePathKey property is not empty, then it overrides the default path to the TomTom Automotive UI onboard map keystore.

  • In all cases the automotiveUiOnboardMapKeystorePassword property should be configured locally in order to be used. If the property is not set the onboard map will fail to load.

  • When automotiveUiMapDisplayTileOnboardServiceUriKey property is not empty, then it overrides the default API key for TomTom Automotive UI tile service.

Note: The default Automotive UI Onboard Map values could be found in the com.tomtom.ivi.platform.automotiveui.api.common.configuration.json file.

The property values are obtained from the local.properties file located in the root directory of the project and from Gradle properties. The property values in the local.properties file take precedence over the Gradle properties.

Note: This plugin configures a single API key for all Automotive UI online services. If this is not desired, the individual Automotive UI API keys need to be configured in Android resources or by adding a AutomotiveUiApiKeyStaticConfigurationProvider instance in the Android Application class as static configuration provider. In this case you must set disableAutomotiveUiApiKeyBuildTimeCheck property to true to disable this plugin.

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

Constructors

Link copied to clipboard
fun IviDefaultsAutomotiveUiConfigPlugin()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override fun IviDefaultsExtension.applyDefaults(project: Project)

Inherited functions

Link copied to clipboard
override fun apply(project: Project)