AddSubMenu Class Reference
Constructors
Instance Methods
- getMenuID() ⇒
Number - getMenuIcon() ⇒
Image - getMenuLayout() ⇒
MenuLayout - getMenuName() ⇒
String - getParentID() ⇒
Number - getPosition() ⇒
Number - getSecondaryImage() ⇒
Image - getSecondaryText() ⇒
String - getTertiaryText() ⇒
String - setMenuID(id) ⇒
AddSubMenu - setMenuIcon(icon) ⇒
AddSubMenu - setMenuLayout(layout) ⇒
AddSubMenu - setMenuName(name) ⇒
AddSubMenu - setParentID(id) ⇒
AddSubMenu - setPosition(position) ⇒
AddSubMenu - setSecondaryImage(image) ⇒
AddSubMenu - setSecondaryText(text) ⇒
AddSubMenu - setTertiaryText(text) ⇒
AddSubMenu
Instance Methods
addSubMenu.getMenuID() ⇒ Number
Get the MenuID
Kind: Instance method of AddSubMenu
Returns: Number - the KEY_MENU_ID value
addSubMenu.getMenuIcon() ⇒ Image
Get the MenuIcon
Kind: Instance method of AddSubMenu
Returns: Image - the KEY_MENU_ICON value
addSubMenu.getMenuLayout() ⇒ MenuLayout
Get the MenuLayout
Kind: Instance method of AddSubMenu
Returns: MenuLayout - the KEY_MENU_LAYOUT value
addSubMenu.getMenuName() ⇒ String
Get the MenuName
Kind: Instance method of AddSubMenu
Returns: String - the KEY_MENU_NAME value
addSubMenu.getParentID() ⇒ Number
Get the ParentID
Kind: Instance method of AddSubMenu
Returns: Number - the KEY_PARENT_ID value
addSubMenu.getPosition() ⇒ Number
Get the Position
Kind: Instance method of AddSubMenu
Returns: Number - the KEY_POSITION value
addSubMenu.getSecondaryImage() ⇒ Image
Get the SecondaryImage
Kind: Instance method of AddSubMenu
Returns: Image - the KEY_SECONDARY_IMAGE value
addSubMenu.getSecondaryText() ⇒ String
Get the SecondaryText
Kind: Instance method of AddSubMenu
Returns: String - the KEY_SECONDARY_TEXT value
addSubMenu.getTertiaryText() ⇒ String
Get the TertiaryText
Kind: Instance method of AddSubMenu
Returns: String - the KEY_TERTIARY_TEXT value
addSubMenu.setMenuID(id) ⇒ AddSubMenu
Set the MenuID
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
unique ID of the sub menu to add. - The desired MenuID. {'num_min_value': 1, 'num_max_value': 2000000000} |
addSubMenu.setMenuIcon(icon) ⇒ AddSubMenu
Set the MenuIcon
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| icon | Image |
The image field for AddSubMenu - The desired MenuIcon. |
addSubMenu.setMenuLayout(layout) ⇒ AddSubMenu
Set the MenuLayout
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| layout | MenuLayout |
Sets the layout of the submenu screen. - The desired MenuLayout. |
addSubMenu.setMenuName(name) ⇒ AddSubMenu
Set the MenuName
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
Text to show in the menu for this sub menu. - The desired MenuName. {'string_min_length': 1, 'string_max_length': 500} |
addSubMenu.setParentID(id) ⇒ AddSubMenu
Set the ParentID
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
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. - The desired ParentID. {'default_value': 0, 'num_min_value': 0, 'num_max_value': 2000000000} |
addSubMenu.setPosition(position) ⇒ AddSubMenu
Set the Position
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| position | Number |
Position within the items that are at top level of the in application menu. 0 will insert at the front. 1 will insert at the second position. If position is greater or equal than the number of items on top level, the sub menu will be appended to the end. Position of any submenu will always be located before the return and exit options If this param was omitted the entry will be added at the end. - The desired Position. {'default_value': 1000, 'num_min_value': 0, 'num_max_value': 1000} |
addSubMenu.setSecondaryImage(image) ⇒ AddSubMenu
Set the SecondaryImage
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| image | Image |
Optional secondary image struct for sub-menu cell - The desired SecondaryImage. |
addSubMenu.setSecondaryText(text) ⇒ AddSubMenu
Set the SecondaryText
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text | String |
Optional secondary text to display - The desired SecondaryText. {'string_min_length': 1, 'string_max_length': 500} |
addSubMenu.setTertiaryText(text) ⇒ AddSubMenu
Set the TertiaryText
Kind: Instance method of AddSubMenu
Returns: AddSubMenu - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| text | String |
Optional tertiary text to display - The desired TertiaryText. {'string_min_length': 1, 'string_max_length': 500} |