com.smartdevicelink.proxy.rpc

Class OnButtonPress

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnButtonPress

All Implemented Interfaces:

Cloneable

public class OnButtonPress
extends RPCNotification

Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:

• SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.
• LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released

HMI Status Requirements:

HMILevel:
• The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL.
• The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED.
• Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.
• The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE.
AudioStreamingState:
• Any
SystemContext:
• MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR.

Parameter List:

Name	Type	Description	Req	Notes	SmartDeviceLink Ver Available
buttonName	ButtonName	Name of the button which triggered this event			SmartDeviceLink 1.0
buttonPressMode	ButtonPressMode	Indicates whether this is an SHORT or LONG button press event.			SmartDeviceLink 1.0
customButtonID	Integer	If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)	N	Minvalue=0 Maxvalue=65536	SmartDeviceLink 2.0

Since:

SmartDeviceLink 1.0

See Also:

SubscribeButton, UnsubscribeButton

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BUTTON_NAME
static String	KEY_BUTTON_PRESS_MODE
static String	KEY_CUSTOM_BUTTON_ID

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnButtonPress() Constructs a newly allocated OnButtonPress object
OnButtonPress(ButtonName buttonName, ButtonPressMode buttonPressMode) Constructs a newly allocated OnButtonPress object
OnButtonPress(Hashtable<String,Object> hash) Constructs a newly allocated OnButtonPress object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
ButtonName	getButtonName() Returns an ButtonName the button's name
ButtonPressMode	getButtonPressMode() Returns ButtonPressMode
Integer	getCustomButtonID() Get CustomButtonID of the button If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button.
OnButtonPress	setButtonName(ButtonName buttonName) Set the button's name
OnButtonPress	setButtonPressMode(ButtonPressMode buttonPressMode) Set the button press mode of the event
OnButtonPress	setCustomButtonID(Integer customButtonID) Set CustomButtonID of the button If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button.

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_BUTTON_PRESS_MODE

public static final String KEY_BUTTON_PRESS_MODE

See Also:

Constant Field Values

KEY_BUTTON_NAME

public static final String KEY_BUTTON_NAME

See Also:

Constant Field Values

KEY_CUSTOM_BUTTON_ID

public static final String KEY_CUSTOM_BUTTON_ID

See Also:

Constant Field Values

Constructor Detail

OnButtonPress

public OnButtonPress()

Constructs a newly allocated OnButtonPress object

OnButtonPress

public OnButtonPress(Hashtable<String,Object> hash)

Constructs a newly allocated OnButtonPress object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnButtonPress

public OnButtonPress(@NonNull
                     ButtonName buttonName,
                     @NonNull
                     ButtonPressMode buttonPressMode)

Constructs a newly allocated OnButtonPress object

Parameters:

buttonName - name of the button

buttonPressMode - indicates whether this is a short or long press

Method Detail

getButtonName

public ButtonName getButtonName()

Returns an ButtonName the button's name

Returns:

ButtonName Name of the button

setButtonName

public OnButtonPress setButtonName(@NonNull
                                   ButtonName buttonName)

Set the button's name

Parameters:

buttonName - name of the button

getButtonPressMode

public ButtonPressMode getButtonPressMode()

Returns ButtonPressMode

Returns:

ButtonPressMode whether this is a long or short button press event

setButtonPressMode

public OnButtonPress setButtonPressMode(@NonNull
                                        ButtonPressMode buttonPressMode)

Set the button press mode of the event

Parameters:

buttonPressMode - indicates whether this is a short or long press

setCustomButtonID

public OnButtonPress setCustomButtonID(Integer customButtonID)

Set CustomButtonID of the button If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)

Parameters:

customButtonID - CustomButtonID of the button

getCustomButtonID

public Integer getCustomButtonID()

Get CustomButtonID of the button If ButtonName is "CUSTOM_BUTTON", this references the integer ID passed by a custom button. (e.g. softButton ID)

Returns:

CustomButtonID of the button