OnButtonPress Class Reference
Constructors
Instance Methods
- getButtonName() ⇒
ButtonName - getButtonPressMode() ⇒
ButtonPressMode - getCustomButtonID() ⇒
Number - setButtonName(name) ⇒
OnButtonPress - setButtonPressMode(mode) ⇒
OnButtonPress - setCustomButtonID(id) ⇒
OnButtonPress
Instance Methods
onButtonPress.getButtonName() ⇒ ButtonName
Get the ButtonName
Kind: Instance method of OnButtonPress
Returns: ButtonName - the KEY_BUTTON_NAME value
onButtonPress.getButtonPressMode() ⇒ ButtonPressMode
Get the ButtonPressMode
Kind: Instance method of OnButtonPress
Returns: ButtonPressMode - the KEY_BUTTON_PRESS_MODE value
onButtonPress.getCustomButtonID() ⇒ Number
Get the CustomButtonID
Kind: Instance method of OnButtonPress
Returns: Number - the KEY_CUSTOM_BUTTON_ID value
onButtonPress.setButtonName(name) ⇒ OnButtonPress
Set the ButtonName
Kind: Instance method of OnButtonPress
Returns: OnButtonPress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | ButtonName |
Defines the hard (physical) and soft (touchscreen) buttons available from the module - The desired ButtonName. |
onButtonPress.setButtonPressMode(mode) ⇒ OnButtonPress
Set the ButtonPressMode
Kind: Instance method of OnButtonPress
Returns: OnButtonPress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| mode | ButtonPressMode |
Indicates whether this is a LONG or SHORT button press event. - The desired ButtonPressMode. |
onButtonPress.setCustomButtonID(id) ⇒ OnButtonPress
Set the CustomButtonID
Kind: Instance method of OnButtonPress
Returns: OnButtonPress - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID) - The desired CustomButtonID. {'num_min_value': 0, 'num_max_value': 65536} |