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.

Parameters

panelTypesName

The name of the property that holds the panel types.

The property name must be formatted in SCREAMING_SNAKE_CASE and must end with the _PANEL_TYPES suffix. The _PANEL_TYPES suffix is mandatory to allow the reference to the property name to be found in the code base easier.

The property name needs to match a property with the same name that is an instance of the com.tomtom.ivi.platform.frontend.api.common.frontend.panels.PanelTypeSet class.

implementationModule

The module that contains the property that is an instance of the com.tomtom.ivi.platform.frontend.api.common.frontend.panels.PanelTypeSet class. See panelTypesName for details.

The package name of the property is obtained from this ModuleReference. If the property resides in a sub package within this module, the sub package can be provided through subPackageName. This subPackageName is appended to the package name of the module, with a period in between.

subPackageName

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

Constructors

Link copied to clipboard
constructor(panelTypesName: String, implementationModule: ModuleReference, subPackageName: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
val subPackageName: String? = null