Class ButtonPress
Hierarchy
java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
- Package
- com.smartdevicelink.proxy.rpc
Overview
This function allows a remote control type mobile application simulate a hardware button press event.Quick Jump
- Fields
- Constructors
- Methods
Fields
KEY_MODULE_TYPE
public static final java.lang.String KEY_MODULE_TYPE
- Constant Value
- "moduleType"
KEY_BUTTON_NAME
public static final java.lang.String KEY_BUTTON_NAME
- Constant Value
- "buttonName"
KEY_BUTTON_PRESS_MODE
public static final java.lang.String KEY_BUTTON_PRESS_MODE
- Constant Value
- "buttonPressMode"
KEY_MODULE_ID
public static final java.lang.String KEY_MODULE_ID
- Constant Value
- "moduleId"
Inherited Fields
Constructors
ButtonPress()
Constructs a new ButtonPress object
public ButtonPress()
ButtonPress( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
Constructs a new ButtonPress object indicated by the Hashtable parameter
public ButtonPress(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructor Parameters
- hash
- The Hashtable to use
ButtonPress( ModuleType moduleType, ButtonName buttonName, ButtonPressMode buttonPressMode )
Constructs a new ButtonPress object
public ButtonPress(ModuleType moduleType,ButtonName buttonName,ButtonPressMode buttonPressMode)
Constructor 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.
Methods
getModuleType()
Gets the ModuleType
public com.smartdevicelink.proxy.rpc.enums.ModuleType getModuleType()
setModuleType( ModuleType moduleType )
Sets a ModuleType
public com.smartdevicelink.proxy.rpc.ButtonPress setModuleType(ModuleType moduleType)
Method Parameters
- moduleType
- Represents module where the button should be pressed
getButtonName()
Gets the ButtonName
public com.smartdevicelink.proxy.rpc.enums.ButtonName getButtonName()
setButtonName( ButtonName buttonName )
Sets a ButtonName
public com.smartdevicelink.proxy.rpc.ButtonPress setButtonName(ButtonName buttonName)
Method Parameters
- buttonName
- Represents name of supported RC climate or radio button
getButtonPressMode()
Gets the ButtonPressMode
public com.smartdevicelink.proxy.rpc.enums.ButtonPressMode getButtonPressMode()
setButtonPressMode( ButtonPressMode buttonPressMode )
Sets a ButtonPressMode
public com.smartdevicelink.proxy.rpc.ButtonPress setButtonPressMode(ButtonPressMode buttonPressMode)
Method Parameters
- buttonPressMode
- Indicates whether this is a LONG or SHORT button press event.
setModuleId( String id )
Sets the module id for this object
public com.smartdevicelink.proxy.rpc.ButtonPress setModuleId(String id)
Method Parameters
- id
- the id to be set
getModuleId()
Gets the module id of this object
public java.lang.String getModuleId()
Inherited Methods
| From Class | Methods |
|---|---|
| com.smartdevicelink.proxy.RPCRequest | getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener |
| com.smartdevicelink.proxy.RPCMessage | getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong |
| com.smartdevicelink.proxy.RPCStruct | getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode |
| java.lang.Object | getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize |