Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class DeleteCommand

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_CMD_ID

public static final java.lang.String KEY_CMD_ID
Constant Value
"cmdID"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCRequest onResponseListener
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

DeleteCommand()

Constructs a new DeleteCommand object

public DeleteCommand()

DeleteCommand( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new DeleteCommand object indicated by the Hashtable parameter

public DeleteCommand(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash
The Hashtable to use

DeleteCommand( Integer cmdID )

Constructs a new DeleteCommand object

public DeleteCommand(Integer cmdID)

Parameters

cmdID

Methods

getCmdID()

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

public java.lang.Integer getCmdID()

setCmdID( Integer cmdID )

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

public void setCmdID(Integer cmdID)

Parameters

cmdID
an Integer value representing Command ID

Notes: Min Value: 0; Max Value: 2000000000

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCRequest getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, deserializeJSONObject, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section