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
ButtonCapabilities

ButtonCapabilities Class Reference

Constructors

Instance Methods

Constructors

new ButtonCapabilities(parameters)

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

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

ParamTypeDescription
info ModuleInfo Information about a 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.

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

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

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