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

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.

See IviServiceHostConfig for an example.

Constructors

fun IviServiceInterfaceConfig(serviceName: String, serviceId: String? = null, serviceApiModule: ModuleReference, multipleInstances: Boolean = false, subPackageName: String? = null)

Types

Companion

object Companion

Properties

multipleInstances

val multipleInstances: Boolean = false

Denotes this interface as a multiple instance interface. If this set to true, the service implementation can be started for each IviInstanceIdentifier configured in the IVI application. If false, the service will run as a global instance.

serviceApiModule

val serviceApiModule: ModuleReference

The module that contains the IVI service interface: the Kotlin interface annotated with the IviService or IviDiscoverableService annotation.

serviceId

val serviceId: String? = null

The service ID of the discoverable service when not null.

serviceName

val serviceName: String

The IVI service name.

subPackageName

val subPackageName: String? = null

Optional sub package. If not null, this value is appended to the ModuleReference.packageName of the serviceApiModule property with a period in between.