CreateGraphicFileMenu

Metreos.Native.CiscoIpPhone.CreateGraphicFileMenu

Summary

CreateGraphicFileMenu initializes a GraphicFileMenu XML object, which one can later use to display a PNG-based menu on a Cisco IP Phone.

Usage

CreateGraphicFileMenu allows the developer to establish the Title, Prompt, and image properties of a Cisco IP Phone GraphicFileMenu XML object. These parameters are stored into the GraphicFileMenu 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 menu object.

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 file 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).
URLSystem.StringThe URL of the PNG image to display. This URL must be accessible to the phone.
Format URLSystem.BooleantrueIndicates that URL format validation should be performed on the URL specified. This may involve modifications being made to the URL.
Result Data
Parameter Name.NET TypeDescription
ResultDataMetreos.Types.CiscoIpPhone.CiscoIPPhoneGraphicFileMenuTypeOne must always save this result data into a GraphicFileMenu XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.