com.smartdevicelink.proxy.rpc

Class OnButtonEvent

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnButtonEvent

All Implemented Interfaces:

Cloneable

public class OnButtonEvent
extends RPCNotification

Notifies application that user has depressed or released a button to which the application has subscribed.Further information about button events and button-presses can be found at SubscribeButton.

HMI Status Requirements:

HMILevel:
• The application will receive OnButtonEvent notifications for all subscribed buttons when HMILevel is FULL.
• The application will receive OnButtonEvent 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 OnButtonEvent notification when HMILevel is BACKGROUND.
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
buttonEventMode	ButtonEventMode	Indicates button was depressed (DOWN) or released (UP)			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_EVENT_MODE
static String	KEY_BUTTON_NAME
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
OnButtonEvent() Constructs a newly allocated OnButtonEvent object
OnButtonEvent(ButtonName buttonName, ButtonEventMode buttonEventMode) Constructs a newly allocated OnButtonEvent object
OnButtonEvent(Hashtable<String,Object> hash) Constructs a newly allocated OnButtonEvent object indicated by the Hashtable parameter

Method Summary

Modifier and Type	Method and Description
ButtonEventMode	getButtonEventMode() Return ButtonEventMode indicates the button was depressed or released
ButtonName	getButtonName() Returns ButtonName the button's name
Integer	getCustomButtonID()
OnButtonEvent	setButtonEventMode(ButtonEventMode buttonEventMode) Set the event mode of the button,pressed or released
OnButtonEvent	setButtonName(ButtonName buttonName) Set the button's name
OnButtonEvent	setCustomButtonID(Integer customButtonID)

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_EVENT_MODE

public static final String KEY_BUTTON_EVENT_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

OnButtonEvent

public OnButtonEvent()

Constructs a newly allocated OnButtonEvent object

OnButtonEvent

public OnButtonEvent(Hashtable<String,Object> hash)

Constructs a newly allocated OnButtonEvent object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use to create this RPC

OnButtonEvent

public OnButtonEvent(@NonNull
                     ButtonName buttonName,
                     @NonNull
                     ButtonEventMode buttonEventMode)

Constructs a newly allocated OnButtonEvent object

Parameters:

buttonName - name of the button

buttonEventMode - indicates the button is pressed or released

Method Detail

getButtonName

public ButtonName getButtonName()

Returns ButtonName the button's name

Returns:

ButtonName Name of the button

setButtonName

public OnButtonEvent setButtonName(@NonNull
                                   ButtonName buttonName)

Set the button's name

Parameters:

buttonName - name of the button

getButtonEventMode

public ButtonEventMode getButtonEventMode()

Return ButtonEventMode indicates the button was depressed or released

Returns:

ButtonEventMode the button depressed or released

setButtonEventMode

public OnButtonEvent setButtonEventMode(@NonNull
                                        ButtonEventMode buttonEventMode)

Set the event mode of the button,pressed or released

Parameters:

buttonEventMode - indicates the button is pressed or released

See Also:

ButtonEventMode

setCustomButtonID

public OnButtonEvent setCustomButtonID(Integer customButtonID)

getCustomButtonID

public Integer getCustomButtonID()