Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
HMISettingsControlCapabilities

HMISettingsControlCapabilities Class Reference

Constructors

Instance Methods

Constructors

new HMISettingsControlCapabilities(parameters)

Initalizes 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.

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
info ModuleInfo Information about a 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.

ParamTypeDescription
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.

ParamTypeDescription
available Boolean Availability of the control of temperature unit. - The desired TemperatureUnitAvailable.
View on GitHub.com
Previous Section Next Section