com.smartdevicelink.proxy.rpc

Class OnCommand

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnCommand

All Implemented Interfaces:

Cloneable

public class OnCommand
extends RPCNotification

This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button.

Note: Sequence of OnHMIStatus and OnCommand notifications for user-initiated interactions is indeterminate.

HMI Status Requirements:

HMILevel:
• FULL,LIMITED
AudioStreamingState:
• Any
SystemContext:
• Any

Parameter List:

Name	Type	Description	Notes	SmartDeviceLink Ver Available
cmdID	Integer	The cmdID of the command the user selected. This is the cmdID value provided by the application in the AddCommand operation that created the command.		SmartDeviceLink 1.0
triggerSource	TriggerSource	Indicates whether command was selected via VR or via a menu selection (using the OK button).		SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

See Also:

AddCommand, DeleteCommand, DeleteSubMenu

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CMD_ID
static String	KEY_TRIGGER_SOURCE

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
OnCommand() Constructs a newly allocated OnCommand object
OnCommand(Hashtable<String,Object> hash) Constructs a newly allocated OnCommand object indicated by the Hashtable parameter
OnCommand(Integer cmdID, TriggerSource triggerSource) Constructs a newly allocated OnCommand object

Method Summary

Modifier and Type	Method and Description
Integer	getCmdID() Returns an Integer object representing the Command ID
TriggerSource	getTriggerSource() Returns a TriggerSource object which will be shown in the HMI
OnCommand	setCmdID(Integer cmdID) Sets a Command ID
OnCommand	setTriggerSource(TriggerSource triggerSource) Sets TriggerSource

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_CMD_ID

public static final String KEY_CMD_ID

See Also:

Constant Field Values

KEY_TRIGGER_SOURCE

public static final String KEY_TRIGGER_SOURCE

See Also:

Constant Field Values

Constructor Detail

OnCommand

public OnCommand()

Constructs a newly allocated OnCommand object

OnCommand

public OnCommand(Hashtable<String,Object> hash)

Constructs a newly allocated OnCommand object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnCommand

public OnCommand(@NonNull
                 Integer cmdID,
                 @NonNull
                 TriggerSource triggerSource)

Constructs a newly allocated OnCommand object

Parameters:

cmdID - an integer object representing a Command ID

triggerSource - a TriggerSource object

Method Detail

getCmdID

public Integer getCmdID()

Returns an Integer object representing the Command ID

Returns:

Integer an integer representation of this object

setCmdID

public OnCommand setCmdID(@NonNull
                          Integer cmdID)

Sets a Command ID

Parameters:

cmdID - an integer object representing a Command ID

getTriggerSource

public TriggerSource getTriggerSource()

Returns a TriggerSource object which will be shown in the HMI

Returns:

TriggerSource a TriggerSource object

setTriggerSource

public OnCommand setTriggerSource(@NonNull
                                  TriggerSource triggerSource)

Sets TriggerSource

Indicates whether command was selected via VR or via a menu selection (using the OK button).

Parameters:

triggerSource - a TriggerSource object