api_common_iviapplication/com.tomtom.ivi.platform.gradle.api.common.iviapplication.config

Package-level declarations

This package defines the common configuration components for the IVI project. These can be used, for instance, to define the reference to a frontend implementation and how to configure it.

Types

AndroidServiceConfig

data class AndroidServiceConfig(val androidServiceName: String) : Serializable

Defines the reference to an Android service.

ApplicationClassExtensionConfig

data class ApplicationClassExtensionConfig(val applicationClassExtensionBuilderName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val dependencies: IviServiceDependencies = IviServiceDependencies())

Defines the reference to an application class extension implementation and how to configure it.

ArgumentValueConfig

sealed class ArgumentValueConfig : Serializable

Defines an argument value that can be generated in code as a constructor argument or a function call argument.

BroadcastReceiverConfig

data class BroadcastReceiverConfig(val broadcastReceiverName: String) : Serializable

Defines the reference to a broadcast receiver.

ConfigurationProviderConfig

sealed class ConfigurationProviderConfig

Defines the reference to a configuration provider implementation and how to construct it.

DynamicConfigurationProviderConfig

class DynamicConfigurationProviderConfig(val configurationProviderName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val constructorArguments: List<ArgumentValueConfig> = emptyList()) : ConfigurationProviderConfig

Defines the reference to a dynamic configuration provider implementation and how to construct it.

FrontendConfig

data class FrontendConfig(val frontendBuilderName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val creationPolicy: FrontendCreationPolicy = FrontendCreationPolicy.CREATE_AFTER_STARTUP, val extensions: List<FrontendExtensionConfig> = emptyList(), val intentFilters: List<IntentFilterConfig> = emptyList(), val availablePanelTypes: PanelTypesConfig? = null, val dependencies: IviServiceDependencies = IviServiceDependencies())

Defines the reference to a frontend implementation and how to configure it.

FrontendCreationPolicy

enum FrontendCreationPolicy : Enum<FrontendCreationPolicy>

Defines when to create a frontend.

FrontendExtensionConfig

data class FrontendExtensionConfig(val frontendExtensionName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val dependencies: IviServiceDependencies = IviServiceDependencies())

Defines a reference to a frontend extension implementation.

IntentFilterConfig

data class IntentFilterConfig(val actions: List<String>, val categories: List<String> = emptyList(), val dataTypes: List<String> = emptyList(), val dataSchemas: List<String> = emptyList()) : Serializable

Intent filter configuration suitable for being used in Gradle configurations.

IviAppsuite

object IviAppsuite

Object used to indicate the origin of a build configuration item is from the IVI appsuite.

IviDefaultsGroupConfig

data class IviDefaultsGroupConfig(val groupName: String, val category: IviDefaultsGroupConfig.Category, val optInPolicy: IviDefaultsGroupConfig.OptInPolicy) : Serializable

Defines an IVI application defaults group and configures if the groups requires an opt-in to be used in an IVI application configuration.

IviInstanceIdentifier

data class IviInstanceIdentifier(val id: String) : Serializable

Identifies an IVI instance.

IviPlatform

object IviPlatform

Object used to indicate the origin of a build configuration item is from the IVI platform.

IviServiceConnectionType

enum IviServiceConnectionType : Enum<IviServiceConnectionType>

IVI service connection types.

IviServiceDependencies

data class IviServiceDependencies(val required: List<IviServiceInterfaceConfig> = emptyList(), val optional: List<IviServiceInterfaceConfig> = emptyList())

Defines dependencies on IVI service interfaces.

IviServiceHostConfig

data class IviServiceHostConfig : Serializable

Defines the implementation and the IVI service interfaces of an IVI service host.

IviServiceInterfaceConfig

data class IviServiceInterfaceConfig(val serviceName: String, val serviceId: String? = null, val serviceApiModule: ModuleReference, val multipleInstances: Boolean = false, val subPackageName: String? = null) : Serializable

Defines an IVI service interface of an IviServiceHostConfig.

IviThemeRegistrySourceConfig

data class IviThemeRegistrySourceConfig(val registrySourceBuilderName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val dependencies: IviServiceDependencies = IviServiceDependencies())

Defines the reference to an IviThemeRegistrySource implementation and how to configure it.

MenuItemConfig

data class MenuItemConfig(val menuItemName: String, val implementationModule: ModuleReference, val subPackageName: String? = null) : Serializable

Defines a reference to a menu item instance.

PanelTypesConfig

data class PanelTypesConfig(val panelTypesName: String, val implementationModule: ModuleReference, val subPackageName: String? = null) : Serializable

Defines a reference to a collection of panel types available to a frontend.

RuntimeDeploymentIdentifier

data class RuntimeDeploymentIdentifier(val id: String) : Serializable

Identifies the runtime deployment.

StaticConfigurationProviderConfig

class StaticConfigurationProviderConfig(val configurationProviderName: String, val implementationModule: ModuleReference, val subPackageName: String? = null, val constructorArguments: List<ArgumentValueConfig> = emptyList()) : ConfigurationProviderConfig

Defines the reference to a static configuration provider implementation and how to construct it.

Inherited functions

toExternal

fun IviServiceHostConfig.toExternal(applicationPackageName: String): IviServiceHostConfig

Transforms an IviServiceHostConfig to an external IVI service host in applicationPackageName. The transformed IviServiceHostConfig must be exported. See IviServiceHostConfig.exported.