OnButtonEvent Class Reference
Constructors
Instance Methods
- getButtonEventMode() ⇒
ButtonEventMode - getButtonName() ⇒
ButtonName - getCustomButtonID() ⇒
Number - setButtonEventMode(mode) ⇒
OnButtonEvent - setButtonName(name) ⇒
OnButtonEvent - setCustomButtonID(id) ⇒
OnButtonEvent
Instance Methods
onButtonEvent.getButtonEventMode() ⇒ ButtonEventMode
Get the ButtonEventMode
Kind: Instance method of OnButtonEvent
Returns: ButtonEventMode - the KEY_BUTTON_EVENT_MODE value
onButtonEvent.getButtonName() ⇒ ButtonName
Get the ButtonName
Kind: Instance method of OnButtonEvent
Returns: ButtonName - the KEY_BUTTON_NAME value
onButtonEvent.getCustomButtonID() ⇒ Number
Get the CustomButtonID
Kind: Instance method of OnButtonEvent
Returns: Number - the KEY_CUSTOM_BUTTON_ID value
onButtonEvent.setButtonEventMode(mode) ⇒ OnButtonEvent
Set the ButtonEventMode
Kind: Instance method of OnButtonEvent
Returns: OnButtonEvent - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| mode | ButtonEventMode |
Indicates whether this is an UP or DOWN event. - The desired ButtonEventMode. |
onButtonEvent.setButtonName(name) ⇒ OnButtonEvent
Set the ButtonName
Kind: Instance method of OnButtonEvent
Returns: OnButtonEvent - 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. |
onButtonEvent.setCustomButtonID(id) ⇒ OnButtonEvent
Set the CustomButtonID
Kind: Instance method of OnButtonEvent
Returns: OnButtonEvent - 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} |