com.smartdevicelink.proxy.rpc

Class DeleteCommand

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.DeleteCommand

All Implemented Interfaces:

Cloneable

public class DeleteCommand
extends RPCRequest

Removes a command from the Command Menu.

HMI Status Requirements:

HMILevel: FULL, LIMITED or BACKGROUND

AudioStreamingState: N/A

SystemContext: Should not be attempted when VRSESSION or MENU

Parameter List

Name	Type	Description	Reg.	Notes	Version
cmdID	Integer	Unique ID that identifies the Command to be deleted from Command Menu	Y	Min Value: 0;Max Value: 2000000000	SmartDeviceLink 1.0

Response:

Indicates that the corresponding request either failed or succeeded. If the response returns with a SUCCESS result code,this means a command was removed from the Command Menu successfully.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

INVALID_ID

IN_USER

Since:

SmartDeviceLink 1.0

See Also:

AddCommand, AddSubMenu, DeleteSubMenu

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CMD_ID

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
DeleteCommand() Constructs a new DeleteCommand object
DeleteCommand(Hashtable<String,Object> hash) Constructs a new DeleteCommand object indicated by the Hashtable parameter
DeleteCommand(Integer cmdID) Constructs a new DeleteCommand object

Method Summary

Modifier and Type	Method and Description
Integer	getCmdID() Gets the Command ID that identifies the Command to be deleted from Command Menu
DeleteCommand	setCmdID(Integer cmdID) Sets the Command ID that identifies the Command to be deleted from Command Menu

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_CMD_ID

public static final String KEY_CMD_ID

See Also:

Constant Field Values

Constructor Detail

DeleteCommand

public DeleteCommand()

Constructs a new DeleteCommand object

DeleteCommand

public DeleteCommand(Hashtable<String,Object> hash)

Constructs a new DeleteCommand object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DeleteCommand

public DeleteCommand(@NonNull
                     Integer cmdID)

Constructs a new DeleteCommand object

Parameters:

cmdID: - an Integer value representing Command ID

Method Detail

getCmdID

public Integer getCmdID()

Gets the Command ID that identifies the Command to be deleted from Command Menu

Returns:

Integer - Integer value representing Command ID that identifies the Command to be deleted from Command Menu

setCmdID

public DeleteCommand setCmdID(@NonNull
                              Integer cmdID)

Sets the Command ID that identifies the Command to be deleted from Command Menu

Parameters:

cmdID - an Integer value representing Command ID

Notes: Min Value: 0; Max Value: 2000000000