HMISettingsControlCapabilities Class Reference
Constructors
Instance Methods
- getDisplayModeUnitAvailable() ⇒
Boolean - getDistanceUnitAvailable() ⇒
Boolean - getModuleInfo() ⇒
ModuleInfo - getModuleName() ⇒
String - getTemperatureUnitAvailable() ⇒
Boolean - setDisplayModeUnitAvailable(available) ⇒
HMISettingsControlCapabilities - setDistanceUnitAvailable(available) ⇒
HMISettingsControlCapabilities - setModuleInfo(info) ⇒
HMISettingsControlCapabilities - setModuleName(name) ⇒
HMISettingsControlCapabilities - setTemperatureUnitAvailable(available) ⇒
HMISettingsControlCapabilities
Constructors
new HMISettingsControlCapabilities(parameters)
Initializes an instance of HMISettingsControlCapabilities.
Instance Methods
hMISettingsControlCapabilities.getDisplayModeUnitAvailable() ⇒ Boolean
Get the DisplayModeUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: Boolean - the KEY_DISPLAY_MODE_UNIT_AVAILABLE value
hMISettingsControlCapabilities.getDistanceUnitAvailable() ⇒ Boolean
Get the DistanceUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: Boolean - the KEY_DISTANCE_UNIT_AVAILABLE value
hMISettingsControlCapabilities.getModuleInfo() ⇒ ModuleInfo
Get the ModuleInfo
Kind: Instance method of HMISettingsControlCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value
hMISettingsControlCapabilities.getModuleName() ⇒ String
Get the ModuleName
Kind: Instance method of HMISettingsControlCapabilities
Returns: String - the KEY_MODULE_NAME value
hMISettingsControlCapabilities.getTemperatureUnitAvailable() ⇒ Boolean
Get the TemperatureUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: Boolean - the KEY_TEMPERATURE_UNIT_AVAILABLE value
hMISettingsControlCapabilities.setDisplayModeUnitAvailable(available) ⇒ HMISettingsControlCapabilities
Set the DisplayModeUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: HMISettingsControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of HMI display mode. - The desired DisplayModeUnitAvailable. |
hMISettingsControlCapabilities.setDistanceUnitAvailable(available) ⇒ HMISettingsControlCapabilities
Set the DistanceUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: HMISettingsControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of distance unit. - The desired DistanceUnitAvailable. |
hMISettingsControlCapabilities.setModuleInfo(info) ⇒ HMISettingsControlCapabilities
Set the ModuleInfo
Kind: Instance method of HMISettingsControlCapabilities
Returns: HMISettingsControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| info | ModuleInfo |
Information about an RC module, including its id. - The desired ModuleInfo. |
hMISettingsControlCapabilities.setModuleName(name) ⇒ HMISettingsControlCapabilities
Set the ModuleName
Kind: Instance method of HMISettingsControlCapabilities
Returns: HMISettingsControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
The short friendly name of the hmi setting module. It should not be used to identify a module by mobile application. - The desired ModuleName. {'string_min_length': 1, 'string_max_length': 100} |
hMISettingsControlCapabilities.setTemperatureUnitAvailable(available) ⇒ HMISettingsControlCapabilities
Set the TemperatureUnitAvailable
Kind: Instance method of HMISettingsControlCapabilities
Returns: HMISettingsControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of temperature unit. - The desired TemperatureUnitAvailable. |