Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
OnButtonEvent

OnButtonEvent Class Reference

Constructors

Instance Methods

Constructors

new OnButtonEvent(parameters)

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

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

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

ParamTypeDescription
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}
View on GitHub.com
Previous Section Next Section