ButtonCapabilities Class Reference
Constructors
Instance Methods
- getLongPressAvailable() ⇒
Boolean - getModuleInfo() ⇒
ModuleInfo - getNameParam() ⇒
ButtonName - getShortPressAvailable() ⇒
Boolean - getUpDownAvailable() ⇒
Boolean - setLongPressAvailable(available) ⇒
ButtonCapabilities - setModuleInfo(info) ⇒
ButtonCapabilities - setNameParam(name) ⇒
ButtonCapabilities - setShortPressAvailable(available) ⇒
ButtonCapabilities - setUpDownAvailable(available) ⇒
ButtonCapabilities
Instance Methods
buttonCapabilities.getLongPressAvailable() ⇒ Boolean
Get the LongPressAvailable
Kind: Instance method of ButtonCapabilities
Returns: Boolean - the KEY_LONG_PRESS_AVAILABLE value
buttonCapabilities.getModuleInfo() ⇒ ModuleInfo
Get the ModuleInfo
Kind: Instance method of ButtonCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value
buttonCapabilities.getNameParam() ⇒ ButtonName
Get the NameParam
Kind: Instance method of ButtonCapabilities
Returns: ButtonName - the KEY_NAME value
buttonCapabilities.getShortPressAvailable() ⇒ Boolean
Get the ShortPressAvailable
Kind: Instance method of ButtonCapabilities
Returns: Boolean - the KEY_SHORT_PRESS_AVAILABLE value
buttonCapabilities.getUpDownAvailable() ⇒ Boolean
Get the UpDownAvailable
Kind: Instance method of ButtonCapabilities
Returns: Boolean - the KEY_UP_DOWN_AVAILABLE value
buttonCapabilities.setLongPressAvailable(available) ⇒ ButtonCapabilities
Set the LongPressAvailable
Kind: Instance method of ButtonCapabilities
Returns: ButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports a LONG press. Whenever the button is pressed long, onButtonPressed( LONG) will be invoked. - The desired LongPressAvailable. |
buttonCapabilities.setModuleInfo(info) ⇒ ButtonCapabilities
Set the ModuleInfo
Kind: Instance method of ButtonCapabilities
Returns: ButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| info | ModuleInfo |
Information about an RC module, including its id. - The desired ModuleInfo. |
buttonCapabilities.setNameParam(name) ⇒ ButtonCapabilities
Set the NameParam
Kind: Instance method of ButtonCapabilities
Returns: ButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | ButtonName |
The name of the button. See ButtonName. - The desired NameParam. |
buttonCapabilities.setShortPressAvailable(available) ⇒ ButtonCapabilities
Set the ShortPressAvailable
Kind: Instance method of ButtonCapabilities
Returns: ButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports a short press. Whenever the button is pressed short, onButtonPressed( SHORT) will be invoked. - The desired ShortPressAvailable. |
buttonCapabilities.setUpDownAvailable(available) ⇒ ButtonCapabilities
Set the UpDownAvailable
Kind: Instance method of ButtonCapabilities
Returns: ButtonCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
The button supports "button down" and "button up". Whenever the button is pressed, onButtonEvent( DOWN) will be invoked. Whenever the button is released, onButtonEvent( UP) will be invoked. - The desired UpDownAvailable. |