com.smartdevicelink.proxy.rpc

Class DeleteSubMenu

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.DeleteSubMenu

All Implemented Interfaces:

Cloneable

public class DeleteSubMenu
extends RPCRequest

Deletes a submenu from the Command Menu.

Notes: When an app deletes a submenu that has child commands, those child commands are also deleted

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Name	Type	Description	Reg.	Notes	Version
menuID	Integer	Unique ID that identifies the SubMenu to be delete	Y	Min Value: 0; Max Value: 2000000000	SmartDeviceLink 1.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

INVALID_ID

IN_USE

Since:

SmartDeviceLink 1.0

See Also:

AddCommand, AddSubMenu, DeleteCommand

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MENU_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
DeleteSubMenu() Constructs a new DeleteSubMenu object
DeleteSubMenu(Hashtable<String,Object> hash) Constructs a new DeleteSubMenu object indicated by the Hashtable parameter
DeleteSubMenu(Integer menuID) Constructs a new DeleteSubMenu object

Method Summary

Modifier and Type	Method and Description
Integer	getMenuID() Gets the Menu ID that identifies the SubMenu to be delete
DeleteSubMenu	setMenuID(Integer menuID) Sets the MenuID that identifies the SubMenu to be delete

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_MENU_ID

public static final String KEY_MENU_ID

See Also:

Constant Field Values

Constructor Detail

DeleteSubMenu

public DeleteSubMenu()

Constructs a new DeleteSubMenu object

DeleteSubMenu

public DeleteSubMenu(Hashtable<String,Object> hash)

Constructs a new DeleteSubMenu object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

DeleteSubMenu

public DeleteSubMenu(@NonNull
                     Integer menuID)

Constructs a new DeleteSubMenu object

Parameters:

menuID - an Integer value representing menuID that identifies the SubMenu to be delete

Notes: Min Value: 0; Max Value: 2000000000

Method Detail

getMenuID

public Integer getMenuID()

Gets the Menu ID that identifies the SubMenu to be delete

Returns:

Integer -an Integer value representing menuID that identifies the SubMenu to be delete

setMenuID

public DeleteSubMenu setMenuID(@NonNull
                               Integer menuID)

Sets the MenuID that identifies the SubMenu to be delete

Parameters:

menuID - an Integer value representing menuID that identifies the SubMenu to be delete

Notes: Min Value: 0; Max Value: 2000000000