platform_framework_api_common_annotations/com.tomtom.ivi.platform.framework.api.common.annotations/IviExperimental

IviExperimental

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.FUNCTION, AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class IviExperimental(val reasons: IviExperimentalReason, val message: String = EXPERIMENTAL_API_MESSAGE)

This annotation marks TomTom Digital Cockpit API modules that are experimental. A marked class or method requires callers to also be marked with this annotation, or to opt-in to using it with @OptIn(IviExperimental::class).

Note: While the functionality of TomTom Digital Cockpit API modules is typically kept backward compatible, classes or methods marked with this annotation are not guaranteed to be backward compatible. It is used to expose certain functionality to clients sooner, on the condition that they accept the cost of updating their code when integrating a newer version of TomTom Digital Cockpit.

Properties

message

val message: String

A free-form message explaining why a public API is marked as experimental. By default, the message indicates that the API is experimental and may change in the future without providing backwards compatibility.

reasons

val reasons: Array<out IviExperimentalReason>

Optionally one or more reasons that refine why a public API is marked as experimental. It can be used to automatically detect APIs that share a common reason.