MenuParams (sdl_android 5.3.1 API)

java.lang.Object
- com.smartdevicelink.proxy.RPCStruct
- - com.smartdevicelink.proxy.rpc.MenuParams

All Implemented Interfaces:: Cloneable

public class MenuParams
extends RPCStruct

Used when adding a sub menu to an application menu or existing sub menu.

Parameter List

Name	Type	Description	SmartDeviceLink Ver. Available
parentID	Integer	The unique ID of an existing submenu to which a command will be added. If this element is not provided, the command will be added to the top level of the Command Menu. Min: 0 Max: 2000000000	SmartDeviceLink 1.0
position	Integer	Position within the items of the parent 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. Min Value: 0 Max Value: 1000 If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu. If this element is omitted, the entry will be added at the end of the parent menu.	SmartDeviceLink 1.0
menuName	String	Text which appears in menu, representing this command. Min: 1 Max: 100	SmartDeviceLink 1.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

, SmartDeviceLink 1.0

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`KEY_MENU_NAME`
`static String`	`KEY_PARENT_ID`
`static String`	`KEY_POSITION`
`static String`	`KEY_SECONDARY_TEXT`
`static String`	`KEY_TERTIARY_TEXT`

Fields inherited from class com.smartdevicelink.proxy.RPCStruct
KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors
Constructor and Description
`MenuParams()` Constructs a newly allocated MenuParams object
`MenuParams(Hashtable<String,Object> hash)` Constructs a newly allocated MenuParams object indicated by the Hashtable parameter
`MenuParams(String menuName)` Constructs a newly allocated MenuParams object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getMenuName()` Get the text which appears in menu, representing this command.
`Integer`	`getParentID()` Get the unique ID of an existing submenu to which a command will be added.
`Integer`	`getPosition()` Get the position within the items of the parent Command Menu.
`String`	`getSecondaryText()` Gets the secondaryText.
`String`	`getTertiaryText()` Gets the tertiaryText.
`MenuParams`	`setMenuName(String menuName)` Set text which appears in menu, representing this command.
`MenuParams`	`setParentID(Integer parentID)` Set the unique ID of an existing submenu to which a command will be added.
`MenuParams`	`setPosition(Integer position)` Set the position within the items of the parent Command Menu.
`MenuParams`	`setSecondaryText(String secondaryText)` Sets the secondaryText.
`MenuParams`	`setTertiaryText(String tertiaryText)` Sets the tertiaryText.

Methods inherited from class com.smartdevicelink.proxy.RPCStruct
clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, 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_PARENT_ID
```
public static final String KEY_PARENT_ID
```
    See Also:
    
    Constant Field Values
  - 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_SECONDARY_TEXT
```
public static final String KEY_SECONDARY_TEXT
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
  - KEY_TERTIARY_TEXT
```
public static final String KEY_TERTIARY_TEXT
```
    Since:
    
    SmartDeviceLink 7.1.0
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MenuParams
```
public MenuParams()
```
    Constructs a newly allocated MenuParams object
  - MenuParams
```
public MenuParams(Hashtable<String,Object> hash)
```
    Constructs a newly allocated MenuParams object indicated by the Hashtable parameter
    
    Parameters:
    
    hash - The Hashtable to use
  - MenuParams
```
public MenuParams(@NonNull
                  String menuName)
```
    Constructs a newly allocated MenuParams object
    
    Parameters:
    
    menuName - the menu name
- Method Detail
  - getParentID
```
public Integer getParentID()
```
    Get the unique ID of an existing submenu to which a command will be added. If this element is not provided, the command will be added to the top level of the Command Menu.
    
    Returns:
    
    parentID Min: 0 Max: 2000000000
  - setParentID
```
public MenuParams setParentID(Integer parentID)
```
    Set the unique ID of an existing submenu to which a command will be added. If this element is not provided, the command will be added to the top level of the Command Menu.
    
    Parameters:
    
    parentID - Min: 0; Max: 2000000000
  - getPosition
```
public Integer getPosition()
```
    Get the position within the items of the parent 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.
    - Min Value: 0
    - Max Value: 1000
    - If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    - If this element is omitted, the entry will be added at the end of the parent menu.
    Returns:
    
    the position within the items of the parent Command Menu
  - setPosition
```
public MenuParams setPosition(Integer position)
```
    Set the position within the items of the parent 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.
    - Min Value: 0
    - Max Value: 1000
    - If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
    - If this element is omitted, the entry will be added at the end of the parent menu.
    Parameters:
    
    position - Mix: 0 Max: 1000
  - getMenuName
```
public String getMenuName()
```
    Get the text which appears in menu, representing this command.
    - Min: 1
    - Max: 100
    Returns:
    
    menuName the menu name
  - setMenuName
```
public MenuParams setMenuName(@NonNull
                              String menuName)
```
    Set text which appears in menu, representing this command.
    - Min: 1
    - Max: 100
    Parameters:
    
    menuName - the menu name
  - setSecondaryText
```
public MenuParams 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 MenuParams 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

Class MenuParams

Field Summary

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

Constructor Summary

Method Summary

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

Methods inherited from class java.lang.Object

Field Detail

KEY_PARENT_ID

KEY_POSITION

KEY_MENU_NAME

KEY_SECONDARY_TEXT

KEY_TERTIARY_TEXT

Constructor Detail

MenuParams

MenuParams

MenuParams

Method Detail

getParentID

setParentID

getPosition

setPosition

getMenuName

setMenuName

setSecondaryText

getSecondaryText

setTertiaryText

getTertiaryText