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
JavaScript Suite Documentation
LightControlCapabilities

LightControlCapabilities Class Reference

Constructors

Instance Methods

Constructors

new LightControlCapabilities(parameters)

Initalizes an instance of LightControlCapabilities.

Instance Methods

lightControlCapabilities.getModuleInfo() ⇒ ModuleInfo

Get the ModuleInfo

Kind: Instance method of LightControlCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value

lightControlCapabilities.getModuleName() ⇒ String

Get the ModuleName

Kind: Instance method of LightControlCapabilities
Returns: String - the KEY_MODULE_NAME value

lightControlCapabilities.getSupportedLights() ⇒ Array.<LightCapabilities>

Get the SupportedLights

Kind: Instance method of LightControlCapabilities
Returns: Array.<LightCapabilities> - the KEY_SUPPORTED_LIGHTS value

lightControlCapabilities.setModuleInfo(info) ⇒ LightControlCapabilities

Set the ModuleInfo

Kind: Instance method of LightControlCapabilities
Returns: LightControlCapabilities - The class instance for method chaining.

ParamTypeDescription
info ModuleInfo Information about a RC module, including its id. - The desired ModuleInfo.

lightControlCapabilities.setModuleName(name) ⇒ LightControlCapabilities

Set the ModuleName

Kind: Instance method of LightControlCapabilities
Returns: LightControlCapabilities - The class instance for method chaining.

ParamTypeDescription
name String The short friendly name of the light control module. It should not be used to identify a module by mobile application. - The desired ModuleName. {'string_min_length': 1, 'string_max_length': 100}

lightControlCapabilities.setSupportedLights(lights) ⇒ LightControlCapabilities

Set the SupportedLights

Kind: Instance method of LightControlCapabilities
Returns: LightControlCapabilities - The class instance for method chaining.

ParamTypeDescription
lights Array.<LightCapabilities> An array of available LightCapabilities that are controllable. - The desired SupportedLights. {'array_min_size': 1, 'array_max_size': 100}
View on GitHub.com
Previous Section Next Section