CreateGraphicMenu

Metreos.Native.CiscoIpPhone.CreateGraphicMenu

Summary

CreateGraphicMenu initializes a GraphicMenu XML object, which one can later use to display a graphical menu on a Cisco IP Phone, in which the number keys on the Cisco IP phone can be used to trigger phone activity.

Usage

CreateGraphicMenu allows the developer to establish the Title, Prompt and image display properties of a Cisco IP Phone GraphicMenu XML object. These parameters are stored into the GraphicMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items and the AddSoftKeyItem action to add softkeys to the graphic menu object.

CreateImage and CreateGraphicMenu differ only in that, with CreateGraphicMenu, one can specify menu items in addition to the image content. The menu items do not display visually; instead, they correspond to keys on the number pad of the phone. So, practically, an image shown on a graphic menu will also provide visual cues so that the user can determine which key on the keypad to push for a particular option.

Remarks

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.

Action Parameters
Parameter Name.NET TypeDefaultDescription
TitleSystem.StringThe title of the graphic menu XML object. This will be displayed on the Cisco IP Phone.
PromptSystem.StringThe prompt to the user to indicate the action that needs to be taken. This will de displayed on the Cisco IP Phone.
LocationXSystem.Int16The X-coordinate of the image (in pixels).
LocationYSystem.Int16The Y-coordinate of the image (in pixels).
HeightSystem.UInt16The height of the image (in pixels).
WidthSystem.UInt16The width of the image (in pixels).
DepthSystem.UInt16The color depth of the image.
DataSystem.StringThe image data to be displayed. There are no utilities to help format this data. Refer to the Cisco IP Phone Developer documentation.
Result Data
Parameter Name.NET TypeDescription
ResultDataMetreos.Types.CiscoIpPhone.CiscoIPPhoneGraphicMenuTypeOne must always save this result data into a GraphicMenu XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.