LightControlCapabilities Class Reference
Constructors
Instance Methods
- getModuleInfo() ⇒
ModuleInfo - getModuleName() ⇒
String - getSupportedLights() ⇒
Array.<LightCapabilities> - setModuleInfo(info) ⇒
LightControlCapabilities - setModuleName(name) ⇒
LightControlCapabilities - setSupportedLights(lights) ⇒
LightControlCapabilities
Constructors
new LightControlCapabilities(parameters)
Initializes 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.
| Param | Type | Description |
|---|---|---|
| info | ModuleInfo |
Information about an 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| lights | Array.<LightCapabilities> |
An array of available LightCapabilities that are controllable. - The desired SupportedLights. {'array_min_size': 1, 'array_max_size': 100} |