CreateIconFileMenu

Metreos.Native.CiscoIpPhone.CreateIconFileMenu

Summary

CreateIconFileMenu initializes a IconFileMenu XML object, which one can later use to display an icon menu on a Cisco IP Phone.

Usage

CreateIconFileMenu allows the developer to establish the Title and Prompt of a Cisco IP Phone IconFileMenu XML object. These parameters are stored into the IconFileMenu XML type. This type can later be manipulated further by using the AddMenuItem action to add menu items, AddIconItem action to add icon 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 icon 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.
Result Data
Parameter Name.NET TypeDescription
ResultDataMetreos.Types.CiscoIpPhone.CiscoIPPhoneIconFileMenuTypeOne must always save this result data into a IconFileMenu XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.