Native
Synchronous
No Custom Parameters
AddMenuItem adds a menu item to an already-initialized Menu, IconMenu, IconFileMenu, GraphicMenu, or GraphicFileMenu XML object.
AddMenuItem is a multi-purpose action which is used in different ways based on which XML object type it is being used to augment. The reason is that a MenuItem has different meaning depending on which context, and more specifically, which XML object it is being used on. The following is a list of which action parameters are of interest based on which XML object is being augmented with AddMenuItem.:
Menu XML objects respect the Name and URL action parameters.
IconMenu XML objects respect the Name, URL, and IconIndex action parameters.
IconFileMenu XML objects respect the Name, URL, and IconIndex action parameters.
GraphicMenu XML objects respect the Name and URL action parameters.
GraphicFileMenu XML objects respect the Name, URL, TouchAreaX1, TouchAreaX2, TouchAreaY1, and TouchAreaY2 action parameters.
This action does not communicate with a Cisco IP Phone; it only formats XML specific to the schema defined by the Cisco IP Phones that support Cisco IP Phone XML Services. Later in the script the XML object stored in a variable can be sent to the phone with either SendResponse or SendExecute.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| IconIndex | System.UInt16 | An index into the list of icon items to indicate which icon should be shown next to this menu item. This field is valid only when used with a IconMenu or IconFileMenu XML object. | |
| Name | System.String | The name of the menu item. This field is displayed with a menu or an icon menu XML object. With a graphic menu or graphic file menu, it is used as the title of the subsequent XML screen if the item is selected and if the subsequent screen does not specify a title. This field is valid with Menu, IconMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu. | |
| URL | System.String | The URL that the phone will request if this menu item is selected. This field is valid with Menu, IconMenu, IconFileMenu, IconFileMenu, GraphicMenu, and GraphicFileMenu. | |
| Format URL | System.Boolean | true | Indicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL. |
| TouchAreaX1 | System.Int16 | The left side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels). | |
| TouchAreaX2 | System.Int16 | The right side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels). | |
| TouchAreaY1 | System.Int16 | The top side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels). | |
| TouchAreaY2 | System.Int16 | The bottom side of the touch area associated with this menu item. This field is valid only when used with a GraphicFileMenu XML object and with phones that have touch-sensitive displays (in pixels). |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultData | Metreos.Types.CiscoIpPhone.CiscoIPPhoneMenuItemType | One must always save this result data into one of the following: a Menu, IconMenu, IconFileMenu, GraphicMenu, or GraphicFileMenu XML type variable |
Branch Conditions
No description.
No description.