com.smartdevicelink.proxy.rpc

Class OnUpdateSubMenu

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnUpdateSubMenu

All Implemented Interfaces:

Cloneable

public class OnUpdateSubMenu
extends RPCNotification

This notification tells an app to update the AddSubMenu or its 'sub' AddCommand and AddSubMenus with the requested data

Parameter List

Param Name	Type	Description	Required	Version Available
menuID	Integer	This menuID must match a menuID in the current menu structure	Y
updateSubCells	Boolean	If not set, assume false. If true, the app should send AddCommands with parentIDs matching the menuID. These AddCommands will then be attached to the submenu and displayed if the submenu is selected.	N

Since:

SmartDeviceLink 7.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_MENU_ID
static String	KEY_UPDATE_SUB_CELLS

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

Method Summary

Modifier and Type	Method and Description
Integer	getMenuID() Gets the menuID.
Boolean	getUpdateSubCells() Gets the updateSubCells.
OnUpdateSubMenu	setMenuID(Integer menuID) Sets the menuID.
OnUpdateSubMenu	setUpdateSubCells(Boolean updateSubCells) Sets the updateSubCells.

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

KEY_UPDATE_SUB_CELLS

public static final String KEY_UPDATE_SUB_CELLS

See Also:

Constant Field Values

Constructor Detail

OnUpdateSubMenu

public OnUpdateSubMenu()

Constructs a new OnUpdateSubMenu object

OnUpdateSubMenu

public OnUpdateSubMenu(Hashtable<String,Object> hash)

Constructs a new OnUpdateSubMenu object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnUpdateSubMenu

public OnUpdateSubMenu(@NonNull
                       Integer menuID)

Constructs a new OnUpdateSubMenu object

Parameters:

menuID - This menuID must match a menuID in the current menu structure

Method Detail

setMenuID

public OnUpdateSubMenu setMenuID(@NonNull
                                 Integer menuID)

Sets the menuID.

Parameters:

menuID - This menuID must match a menuID in the current menu structure

getMenuID

public Integer getMenuID()

Gets the menuID.

Returns:

Integer This menuID must match a menuID in the current menu structure

setUpdateSubCells

public OnUpdateSubMenu setUpdateSubCells(Boolean updateSubCells)

Sets the updateSubCells.

Parameters:

updateSubCells - If not set, assume false. If true, the app should send AddCommands with parentIDs matching the menuID. These AddCommands will then be attached to the submenu and displayed if the submenu is selected.

getUpdateSubCells

public Boolean getUpdateSubCells()

Gets the updateSubCells.

Returns:

Boolean If not set, assume false. If true, the app should send AddCommands with parentIDs matching the menuID. These AddCommands will then be attached to the submenu and displayed if the submenu is selected.