AddInputItem

Metreos.Native.CiscoIpPhone.AddInputItem

Summary

AddInputItem adds an input item to an already-initialized Input XML object.

Usage

AddInputItem allows the developer to define the properties of a user-accessible prompt that will be added to a Cisco IP Phone Input XML object. This input item is stored into the Input XML type that was previously initialized with the CreateInput action.

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 action parameter in CreateInput 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 for that input item. 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
DisplayNameSystem.StringThe text displayed on the phone for this input item.
QueryStringParamSystem.StringWhen the user hits the Submit softkey, the Cisco IP Phone will add a query parameter to the URL defined by CreateInput, with the value specified by the user for this input item.
DefaultValueSystem.StringA default value to pre-populate the input item prompt.
InputFlagsSystem.StringCisco IP Phone-specific flags that are used to dictate what content can be entered into the prompt.
Result Data
Parameter Name.NET TypeDescription
ResultDataMetreos.Types.CiscoIpPhone.CiscoIPPhoneInputItemTypeOne must always save this result data into a Input XML type variable.

Branch Conditions 

Success

No description.

Failure

No description.