AddSubMenu (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.RPCMessage
  - - com.smartdevicelink.proxy.RPCRequest
    - - com.smartdevicelink.proxy.rpc.AddSubMenu

All Implemented Interfaces:: Cloneable

public class AddSubMenu
extends RPCRequest

Add a SubMenu to the Command Menu

A SubMenu can only be added to the Top Level Menu (i.e.a SubMenu cannot be added to a SubMenu), and may only contain commands as children

HMILevel needs to be FULL, LIMITED or BACKGROUND

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
menuID	Integer	Unique ID that identifies this sub menu. This value is used in AddCommand to which SubMenu is the parent of the command being added.	Y		SmartDeviceLink 1.0
position	Integer	Position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options.	N	Min Value: 0 Max Value: 1000 If position is greater or equal than the number of items on top level, the sub menu will be appended by the end. If this parameter is omitted, the entry will be added at the end of the list.	SmartDeviceLink 1.0
menuName	String	Text which is displayed representing this submenu item	Y	maxlength:500	SmartDeviceLink 1.0
menuIcon	Image	Image to be be shown along with the submenu item	N		SmartDeviceLink 5.0
menuLayout	MenuLayout	Sets the layout of the submenu screen.			SmartDeviceLink 6.0
parentID	Integer	unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.	N	Min Value: 0 Max Value: 2000000000	SmartDeviceLink 7.0.0
secondaryText	String	Optional secondary text to display	N	{"string_min_length": 1, "string_max_length": 500}	Since: SmartDeviceLink 7.1.0
tertiaryText	String	Optional tertiary text to display	N	{"string_min_length": 1, "string_max_length": 500}	, SmartDeviceLink 7.1.0
secondaryImage	Image	Optional secondary image struct for sub-menu cell	N		, SmartDeviceLink 7.1.0

Response

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

Non-default Result Codes:

INVALID_ID

DUPLICATE NAME

, SmartDeviceLink 1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_MENU_ICON`
`static String`	`KEY_MENU_ID`
`static String`	`KEY_MENU_LAYOUT`
`static String`	`KEY_MENU_NAME`
`static String`	`KEY_PARENT_ID`
`static String`	`KEY_POSITION`
`static String`	`KEY_SECONDARY_IMAGE`
`static String`	`KEY_SECONDARY_TEXT`
`static String`	`KEY_TERTIARY_TEXT`

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Image`	`getMenuIcon()` Returns Image to be be shown along with the submenu item
`Integer`	`getMenuID()` Returns an Integer object representing the Menu ID that identifies a sub menu
`MenuLayout`	`getMenuLayout()` Gets the layout of the submenu screen.
`String`	`getMenuName()` Returns String which is displayed representing this submenu item
`Integer`	`getParentID()` Gets the parentID.
`Integer`	`getPosition()` Returns an Integer object representing the position of menu
`Image`	`getSecondaryImage()` Gets the secondaryImage.
`String`	`getSecondaryText()` Gets the secondaryText.
`String`	`getTertiaryText()` Gets the tertiaryText.
`AddSubMenu`	`setMenuIcon(Image menuIcon)` Sets image to be be shown along with the submenu item
`AddSubMenu`	`setMenuID(Integer menuID)` Sets a Menu ID that identifies a sub menu.
`AddSubMenu`	`setMenuLayout(MenuLayout menuLayout)` Sets the layout of the submenu screen.
`AddSubMenu`	`setMenuName(String menuName)` Sets a menuName which is displayed representing this submenu item
`AddSubMenu`	`setParentID(Integer parentID)` Sets the parentID.
`AddSubMenu`	`setPosition(Integer position)` Sets a position of menu
`AddSubMenu`	`setSecondaryImage(Image secondaryImage)` Sets the secondaryImage.
`AddSubMenu`	`setSecondaryText(String secondaryText)` Sets the secondaryText.
`AddSubMenu`	`setTertiaryText(String tertiaryText)` Sets the tertiaryText.

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_POSITION
```
public static final String KEY_POSITION
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_NAME
```
public static final String KEY_MENU_NAME
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_ID
```
public static final String KEY_MENU_ID
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_ICON
```
public static final String KEY_MENU_ICON
```
    See Also:
    
    Constant Field Values
  - KEY_MENU_LAYOUT
```
public static final String KEY_MENU_LAYOUT
```
    See Also:
    
    Constant Field Values
  - KEY_PARENT_ID
```
public static final String KEY_PARENT_ID
```
    See Also:
    
    Constant Field Values
  - KEY_SECONDARY_TEXT
```
public static final String KEY_SECONDARY_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_TERTIARY_TEXT
```
public static final String KEY_TERTIARY_TEXT
```
    See Also:
    
    Constant Field Values
  - KEY_SECONDARY_IMAGE
```
public static final String KEY_SECONDARY_IMAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AddSubMenu
```
public AddSubMenu()
```
    Constructs a new AddSubMenu object
  - AddSubMenu
```
public AddSubMenu(Hashtable<String,Object> hash)
```
    Constructs a new AddSubMenu object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - AddSubMenu
```
public AddSubMenu(@NonNull
                  Integer menuID,
                  @NonNull
                  String menuName)
```
    Constructs a new AddSubMenu object
    
    Parameters:
    
    menuID - an integer object representing a Menu ID
    Notes: Min Value: 0; Max Value: 2000000000
    
    menuName - String which will be displayed representing this submenu item
- Method Detail
  - getMenuID
```
public Integer getMenuID()
```
    Returns an Integer object representing the Menu ID that identifies a sub menu
    
    Returns:
    
    Integer -an integer representing the Menu ID that identifies a sub menu
  - setMenuID
```
public AddSubMenu setMenuID(@NonNull
                            Integer menuID)
```
    Sets a Menu ID that identifies a sub menu.
    This value is used in AddCommand to which SubMenu is the parent of the command being added
    
    Parameters:
    
    menuID - an integer object representing a Menu ID
    Notes: Min Value: 0; Max Value: 2000000000
  - getPosition
```
public Integer getPosition()
```
    Returns an Integer object representing the position of menu
    
    Returns:
    
    Integer -the value representing the relative position of menus
  - setPosition
```
public AddSubMenu setPosition(Integer position)
```
    Sets a position of menu
    Parameters:
    position -
    An Integer object representing the position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of any submenu will always be located before the return and exit options
    Notes:
    
    Min Value: 0; Max Value: 1000
    
    If position is greater than or equal to the number of items on top level, the sub menu will be appended by the end
    
    If this parameter is omitted, the entry will be added at the end of the list
  - getMenuName
```
public String getMenuName()
```
    Returns String which is displayed representing this submenu item
    
    Returns:
    
    String -a Submenu item's name
  - setMenuName
```
public AddSubMenu setMenuName(@NonNull
                              String menuName)
```
    Sets a menuName which is displayed representing this submenu item
    
    Parameters:
    
    menuName - String which will be displayed representing this submenu item
  - getMenuIcon
```
public Image getMenuIcon()
```
    Returns Image to be be shown along with the submenu item
    
    Returns:
    
    Image - the submenu icon
  - setMenuIcon
```
public AddSubMenu setMenuIcon(Image menuIcon)
```
    Sets image to be be shown along with the submenu item
    
    Parameters:
    
    menuIcon - Image to be be shown along with the submenu item
  - setMenuLayout
```
public AddSubMenu setMenuLayout(MenuLayout menuLayout)
```
    Sets the layout of the submenu screen.
    
    Parameters:
    
    menuLayout - - the menuLayout
  - getMenuLayout
```
public MenuLayout getMenuLayout()
```
    Gets the layout of the submenu screen.
    
    Returns:
    
    the MenuLayout
  - setParentID
```
public AddSubMenu setParentID(Integer parentID)
```
    Sets the parentID.
    
    Parameters:
    
    parentID - unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.
    
    Since:
    
    SmartDeviceLink 7.0.0
  - getParentID
```
public Integer getParentID()
```
    Gets the parentID.
    
    Returns:
    
    Integer unique ID of the sub menu, the command will be added to. If not provided or 0, it will be provided to the top level of the in application menu.
    
    Since:
    
    SmartDeviceLink 7.0.0
  - setSecondaryText
```
public AddSubMenu setSecondaryText(String secondaryText)
```
    Sets the secondaryText.
    
    Parameters:
    
    secondaryText - Optional secondary text to display {"string_min_length": 1, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getSecondaryText
```
public String getSecondaryText()
```
    Gets the secondaryText.
    
    Returns:
    
    String Optional secondary text to display {"string_min_length": 1, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setTertiaryText
```
public AddSubMenu setTertiaryText(String tertiaryText)
```
    Sets the tertiaryText.
    
    Parameters:
    
    tertiaryText - Optional tertiary text to display {"string_min_length": 1, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getTertiaryText
```
public String getTertiaryText()
```
    Gets the tertiaryText.
    
    Returns:
    
    String Optional tertiary text to display {"string_min_length": 1, "string_max_length": 500}
    
    Since:
    
    SmartDeviceLink 7.1.0
  - setSecondaryImage
```
public AddSubMenu setSecondaryImage(Image secondaryImage)
```
    Sets the secondaryImage.
    
    Parameters:
    
    secondaryImage - Optional secondary image struct for sub-menu cell
    
    Since:
    
    SmartDeviceLink 7.1.0
  - getSecondaryImage
```
public Image getSecondaryImage()
```
    Gets the secondaryImage.
    
    Returns:
    
    Image Optional secondary image struct for sub-menu cell
    
    Since:
    
    SmartDeviceLink 7.1.0

Class AddSubMenu

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_POSITION

KEY_MENU_NAME

KEY_MENU_ID

KEY_MENU_ICON

KEY_MENU_LAYOUT

KEY_PARENT_ID

KEY_SECONDARY_TEXT

KEY_TERTIARY_TEXT

KEY_SECONDARY_IMAGE

Constructor Detail

AddSubMenu

AddSubMenu

AddSubMenu

Method Detail

getMenuID

setMenuID

getPosition

setPosition

getMenuName

setMenuName

getMenuIcon

setMenuIcon

setMenuLayout

getMenuLayout

setParentID

getParentID

setSecondaryText

getSecondaryText

setTertiaryText

getTertiaryText

setSecondaryImage

getSecondaryImage