Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
OnButtonPress

OnButtonPress Class Reference

Constructors

Instance Methods

Constructors

new OnButtonPress(parameters)

Initalizes an instance of 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.

ParamTypeDescription
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.

ParamTypeDescription
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.

ParamTypeDescription
id Number If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. - The desired CustomButtonID. (e.g. softButton ID)
View on GitHub.com
Previous Section Next Section