Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
MenuParams

MenuParams Class Reference

Constructors

Instance Methods

Constructors

new MenuParams(parameters)

Initalizes an instance of MenuParams.

Instance Methods

menuParams.getMenuName() ⇒ String

Get the MenuName

Kind: Instance method of MenuParams
Returns: String - the KEY_MENU_NAME value

menuParams.getParentID() ⇒ Number

Get the ParentID

Kind: Instance method of MenuParams
Returns: Number - the KEY_PARENT_ID value

menuParams.getPosition() ⇒ Number

Get the Position

Kind: Instance method of MenuParams
Returns: Number - the KEY_POSITION value

menuParams.setMenuName(name) ⇒ MenuParams

Set the MenuName

Kind: Instance method of MenuParams
Returns: MenuParams - The class instance for method chaining.

ParamTypeDescription
name String Text to show in the menu for this sub menu. - The desired MenuName.

menuParams.setParentID(id) ⇒ MenuParams

Set the ParentID

Kind: Instance method of MenuParams
Returns: MenuParams - The class instance for method chaining.

ParamTypeDescription
id Number unique ID of the sub menu, the command will be added to. If not provided, it will be - The desired ParentID. provided to the top level of the in application menu.

menuParams.setPosition(position) ⇒ MenuParams

Set the Position

Kind: Instance method of MenuParams
Returns: MenuParams - The class instance for method chaining.

ParamTypeDescription
position Number Position within the items that are are at top level of the in application menu. 0 will - The desired Position. 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. If this param was omitted the entry will be added at the end.
View on GitHub.com
Previous Section Next Section