CreateInput

Metreos.Native.CiscoIpPhone.CreateInput

Summary

CreateInput initializes a Input XML object, which one can later use to display an input form on a Cisco IP Phone in order to allow the user to input and submit data back to the script.

Usage

CreateInput allows the developer to establish the Title, Prompt, and base URL of the Cisco IP Phone Input XML object. These parameters are stored into the Input XML type. This type can later be manipulated further by using the AddInputItem action to add input items and the AddSoftKeyItem action to add softkeys to the input object.

It is important to understand the interaction between the URL action parameter specified in CreateInput and the QueryStringParam action parameter in the AddInputItem action. The URL parameter defines the base URL. Each QueryStringParam of any input items are appended to the base URL as a query parameter, with the value of the text entered by the user defined as the value of the query parameter. For example, assume we specified a URL of http://appserver:8000/myscript and a QueryStringParam with a value of userid, and also assume the user enters the value bob on the phone. When the user hits the Submit softkey on the Cisco IP Phone, the phone will generate a request to the URI http://appserver:8000/myscript?userid=bob.

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 input 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.
URLSystem.StringThe base URL that the phone will use to generate the request when the user hits Submit on their Cisco IP Phone. This URL is prepended to any query parameters defined by input items.
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.CiscoIPPhoneInputTypeOne must always save this result data into a Input XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.