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

IviInternal

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

annotation class IviInternal(val message: String = INTERNAL_API_MESSAGE)

This annotation marks TomTom Digital Cockpit API modules as internal. A marked class or method requires callers to also be marked with this annotation, or opt-in to using it with @OptIn(IviInternal::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 mark some properties and classes which are used internally by generated code and should not be used directly by a plugin.

Properties

message

val message: String

A free-form message explaining why a public API is marked as internal. By default, the message indicates that the API is meant to be only used internally by TomTom and may change in the future without providing backward compatibility.