profi-sdk-aos-model/com.sygic.profi.model.pm.cfg

Package-level declarations

Pure kotlin data classes for Configuration / setting API

Types

Enumeration of config family

data class PMCfgApk(val apkName: String? = null, val apkVersion: String? = null, val groupId: String? = null, val artifactId: String? = null, val version: String? = null, val libVersions: List<PMCfgKVPair>? = null, val mapVersions: List<PMCfgKVPair>? = null, val features: List<PMCfgFeature>? = null, val deviceDesc: List<PMCfgKVPair>? = null)

Application identification and libraries/maps version

PMCfgChangeOption

data class PMCfgChangeOption(val optionId: String, val valueBool: Boolean = false, val valueString: String? = null, val valueInt: Int = 0, val valueSet: List<String>? = null)

Request to change application configuration

PMCfgChangeVehicle

data class PMCfgChangeVehicle(val vehicleId: String, val optionId: String, val valueBool: Boolean = false, val valueString: String? = null, val valueInt: Int = 0, val valueSet: List<String>? = null)

Request to change application configuration

PMCfgDefinition

data class PMCfgDefinition(val cfgType: PMCfgType, val id: String, val family: PMCfgFamily, val featureName: String? = null, val featureValue: String? = null, val group: String, val name: String, val description: String, val implementation: String? = null, val confidential: Boolean = false, val textTrue: String? = null, val textFalse: String? = null, val intMin: Int = 0, val intMax: Int = 0, val enumValues: List<PMCfgEnumValue>? = null, val defaultBool: Boolean = false, val defaultInt: Int = 0, val defaultString: String? = null, val defaultSet: List<String>? = null, val measurementSystem: PMCfgMeasurementSystem, val guiOrder: String? = null)

definition of one configuration option

PMCfgDefs

data class PMCfgDefs(val cfgDefs: List<PMCfgDefinition>? = null, val vehicleDefs: List<PMCfgDefinition>? = null, val vehicleVariants: List<PMCfgVehicleVariant>? = null)

Represents list of configuration option definitions

PMCfgEnumValue

data class PMCfgEnumValue(val id: String, val name: String, val description: String)

One item of enumeration

PMCfgFamily

enum PMCfgFamily : Enum<PMCfgFamily>

Enumeration of config family

PMCfgFeature

data class PMCfgFeature(val id: String, val name: String? = null, val description: String? = null, val valid: Boolean = false, val validFrom: Int = 0, val validTo: Int = 0)

PMCfgKVPair

data class PMCfgKVPair(val key: String? = null, val value: String? = null)

PMCfgMeasurementSystem

enum PMCfgMeasurementSystem : Enum<PMCfgMeasurementSystem>

Enumeration of possible CFG variants ( based on https://developer.android.com/reference/android/icu/util/LocaleData.MeasurementSystem)

PMCfgMsg

data class PMCfgMsg(val result: PMCfgResult, val text: String? = null)

Message to be shown

PMCfgOption

data class PMCfgOption(val id: String, val cfgType: PMCfgType, val definition: PMCfgDefinition? = null, val valueBool: Boolean = false, val valueString: String? = null, val valueInt: Int = 0, val valueSet: List<String>? = null)

One configuration option

PMCfgOptions

data class PMCfgOptions(val options: List<PMCfgOption>? = null, val vehicles: List<PMCfgVehicle>? = null, val selectedVehicle: String? = null)

Represents list of stored configuration options

PMCfgRequest

data class PMCfgRequest(val correlationId: String? = null, val action: PMCfgAction, val changeCfg: PMCfgChangeOption? = null, val changeVehicle: PMCfgChangeVehicle? = null)

Request message for configuration interface

PMCfgResponse

data class PMCfgResponse(val correlationId: String? = null, val action: PMCfgAction, val defs: PMCfgDefs? = null, val opts: PMCfgOptions? = null, val apkInfo: PMCfgApk? = null, val msg: PMCfgMsg? = null)

Response message for configuration interface

PMCfgResult

enum PMCfgResult : Enum<PMCfgResult>

Importance level of message

PMCfgType

enum PMCfgType : Enum<PMCfgType>

Enumeration of configuration types

PMCfgVehicle

data class PMCfgVehicle(val id: String, val options: List<PMCfgOption>? = null)

One vehicle profile

PMCfgVehicleVariant

data class PMCfgVehicleVariant(val variantId: String? = null, val measurementSystem: PMCfgMeasurementSystem, val variantDefs: List<PMCfgDefinition>? = null)

Represents one vehicle definition variant used on UI for user to choose from preddefined variants