platform_framework_api_ipc_iviserviceannotations/com.tomtom.ivi.platform.framework.api.ipc.iviserviceannotations

Package-level declarations

The annotations of TomTom Digital Cockpit's IPC framework.

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IviDiscoverableService(val importedEnums: Array<KClass<*>> = [], val traceEvents: Boolean = true, val multipleInstances: Boolean = false)

Similar to the IviService annotation, except this type of IVI service allows multiple instances of the same interface to be registered and discovered by clients.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IviService(val serviceId: String, val importedEnums: Array<KClass<*>> = [], val traceEvents: Boolean = true, val multipleInstances: Boolean = false)

An annotation required for IVI service interfaces.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS])
annotation class IviServiceEventListener

Exposes an inner interface of an IVI service as an event listener interface.

@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class IviServiceExperimentalAnnotationForTestPurpose

Only here for testing purpose. Do not use.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])
annotation class IviServiceExperimentalApi

This annotation marks IVI service API as experimental. A marked annotation, class or method requires callers to also be marked with this annotation, or to opt-in to using it with @OptIn(IviServiceExperimentalApi::class).

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.FUNCTION])
annotation class IviServiceFun

Exposes an IVI service interface function in the <Interface>Api class.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.PROPERTY])
@IviExperimental(reasons = [])
annotation class IviSetting(val accessMode: IviSettingAccessMode)

Exposes an IVI property as a setting with accessMode.

Link copied to clipboard
@IviExperimental(reasons = [])
enum IviSettingAccessMode : Enum<IviSettingAccessMode>

Access mode for a property of an IVI settings service.