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
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation

ButtonPress Class Reference

Constructors

Instance Methods

Constructors

new ButtonPress(parameters)

Initializes an instance of ButtonPress.

Instance Methods

buttonPress.getButtonName() ⇒ ButtonName

Get the ButtonName

Kind: Instance method of ButtonPress
Returns: ButtonName - the KEY_BUTTON_NAME value

buttonPress.getButtonPressMode() ⇒ ButtonPressMode

Get the ButtonPressMode

Kind: Instance method of ButtonPress
Returns: ButtonPressMode - the KEY_BUTTON_PRESS_MODE value

buttonPress.getModuleId() ⇒ String

Get the ModuleId

Kind: Instance method of ButtonPress
Returns: String - the KEY_MODULE_ID value

buttonPress.getModuleType() ⇒ ModuleType

Get the ModuleType

Kind: Instance method of ButtonPress
Returns: ModuleType - the KEY_MODULE_TYPE value

buttonPress.setButtonName(name) ⇒ ButtonPress

Set the ButtonName

Kind: Instance method of ButtonPress
Returns: ButtonPress - The class instance for method chaining.

ParamTypeDescription
name ButtonName The name of the supported RC button. - The desired ButtonName.

buttonPress.setButtonPressMode(mode) ⇒ ButtonPress

Set the ButtonPressMode

Kind: Instance method of ButtonPress
Returns: ButtonPress - The class instance for method chaining.

ParamTypeDescription
mode ButtonPressMode Indicates whether this is a LONG or SHORT button press event. - The desired ButtonPressMode.

buttonPress.setModuleId(id) ⇒ ButtonPress

Set the ModuleId

Kind: Instance method of ButtonPress
Returns: ButtonPress - The class instance for method chaining.

ParamTypeDescription
id String Id of a module in the published ButtonCapabilities - The desired ModuleId. {'string_min_length': 1, 'string_max_length': 100}

buttonPress.setModuleType(type) ⇒ ButtonPress

Set the ModuleType

Kind: Instance method of ButtonPress
Returns: ButtonPress - The class instance for method chaining.

ParamTypeDescription
type ModuleType The module where the button should be pressed - The desired ModuleType.
View on GitHub.com