com.smartdevicelink.proxy.rpc

Class ButtonPress

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.ButtonPress

All Implemented Interfaces:

Cloneable

public class ButtonPress
extends RPCRequest

This function allows a remote control type mobile application simulate a hardware button press event.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_BUTTON_NAME
static String	KEY_BUTTON_PRESS_MODE
static String	KEY_MODULE_ID
static String	KEY_MODULE_TYPE

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

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
ButtonPress() Constructs a new ButtonPress object
ButtonPress(Hashtable<String,Object> hash) Constructs a new ButtonPress object indicated by the Hashtable parameter
ButtonPress(ModuleType moduleType, ButtonName buttonName, ButtonPressMode buttonPressMode) Constructs a new ButtonPress object

Method Summary

Modifier and Type	Method and Description
ButtonName	getButtonName() Gets the ButtonName
ButtonPressMode	getButtonPressMode() Gets the ButtonPressMode
String	getModuleId() Gets the module id of this object
ModuleType	getModuleType() Gets the ModuleType
ButtonPress	setButtonName(ButtonName buttonName) Sets a ButtonName
ButtonPress	setButtonPressMode(ButtonPressMode buttonPressMode) Sets a ButtonPressMode
ButtonPress	setModuleId(String id) Sets the module id for this object
ButtonPress	setModuleType(ModuleType moduleType) Sets a ModuleType

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

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_MODULE_TYPE

public static final String KEY_MODULE_TYPE

See Also:

Constant Field Values

KEY_BUTTON_NAME

public static final String KEY_BUTTON_NAME

See Also:

Constant Field Values

KEY_BUTTON_PRESS_MODE

public static final String KEY_BUTTON_PRESS_MODE

See Also:

Constant Field Values

KEY_MODULE_ID

public static final String KEY_MODULE_ID

See Also:

Constant Field Values

Constructor Detail

ButtonPress

public ButtonPress()

Constructs a new ButtonPress object

ButtonPress

public ButtonPress(Hashtable<String,Object> hash)

Constructs a new ButtonPress object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

ButtonPress

public ButtonPress(@NonNull
                   ModuleType moduleType,
                   @NonNull
                   ButtonName buttonName,
                   @NonNull
                   ButtonPressMode buttonPressMode)

Constructs a new ButtonPress object

Parameters:

moduleType - Represents module where the button should be pressed

buttonName - Represents name of supported RC climate or radio button

buttonPressMode - Indicates whether this is a LONG or SHORT button press event.

Method Detail

getModuleType

public ModuleType getModuleType()

Gets the ModuleType

Returns:

ModuleType - The module where the button should be pressed

setModuleType

public ButtonPress setModuleType(@NonNull
                                 ModuleType moduleType)

Sets a ModuleType

Parameters:

moduleType - Represents module where the button should be pressed

getButtonName

public ButtonName getButtonName()

Gets the ButtonName

Returns:

ButtonName - The name of supported RC climate or radio button

setButtonName

public ButtonPress setButtonName(@NonNull
                                 ButtonName buttonName)

Sets a ButtonName

Parameters:

buttonName - Represents name of supported RC climate or radio button

getButtonPressMode

public ButtonPressMode getButtonPressMode()

Gets the ButtonPressMode

Returns:

ButtonPressMode - Indicates whether this is a LONG or SHORT button press event.

setButtonPressMode

public ButtonPress setButtonPressMode(@NonNull
                                      ButtonPressMode buttonPressMode)

Sets a ButtonPressMode

Parameters:

buttonPressMode - Indicates whether this is a LONG or SHORT button press event.

setModuleId

public ButtonPress setModuleId(String id)

Sets the module id for this object

Parameters:

id - the id to be set

getModuleId

public String getModuleId()

Gets the module id of this object

Returns:

the module id of this object