Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
OnUpdateSubMenu

Class OnUpdateSubMenu

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Overview

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

Fields

KEY_MENU_ID

public static final java.lang.String KEY_MENU_ID
Constant Value
"menuID"

KEY_UPDATE_SUB_CELLS

public static final java.lang.String KEY_UPDATE_SUB_CELLS
Constant Value
"updateSubCells"

Inherited Fields

From Class Fields
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

OnUpdateSubMenu()

Constructs a new OnUpdateSubMenu object

public OnUpdateSubMenu()

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

Constructs a new OnUpdateSubMenu object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

OnUpdateSubMenu( Integer menuID )

Constructs a new OnUpdateSubMenu object

public OnUpdateSubMenu(Integer menuID)

Parameters

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

Methods

setMenuID( Integer menuID )

Sets the menuID.

public com.smartdevicelink.proxy.rpc.OnUpdateSubMenu setMenuID(Integer menuID)

Parameters

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

getMenuID()

Gets the menuID.

public java.lang.Integer getMenuID()

setUpdateSubCells( Boolean updateSubCells )

Sets the updateSubCells.

public com.smartdevicelink.proxy.rpc.OnUpdateSubMenu setUpdateSubCells(Boolean 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()

Gets the updateSubCells.

public java.lang.Boolean getUpdateSubCells()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, 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