Cisco OL-20949-01 - Manual (Page 23)

3-5
Cisco Unified IP Phone Services Application Development Notes
OL-20949-01
Chapter 3 CiscoIPPhone XML Objects
XML Object Definitions
CiscoIPPhoneInput
When a Cisco Unified IP Phone receives an XML object of type CiscoIPPhoneInput , it constructs an
input form and displays it. The user then enters data into each input item and sends the parameters to the
target URL.
Figure 3-1 shows a sample display that is receiving input from a user.
Figure 3-1 Sample User Input Display
Definition
<CiscoIPPhoneInput>
<Title>Directory title goes here</Title>
<Prompt>Prompt text goes here</Prompt>
<URL>The target URL for the completed input goes here</URL>
<InputItem>
<DisplayName>Name of the input field to display</DisplayName>
<QueryStringParam>The parameter to be added to the target URL</QueryStringParam>
<DefaultValue>The default display name</DefaultValue>
<InputFlags>The flag specifying the type of allowable input</InputFlags>
</InputItem>
</CiscoIPPhoneInput>
Note The 6900 series IP phones does not display the Title and Prompt menu fields at the same time.
If both Title and Prompt fields are defined at the same time, then these phones display only the
Prompt field.
The Title and Prompt tags in the object delimit text are used in the same way as the identical fields in
the other CiscoIPPhone XML objects.
The URL tag delimits the URL to which the input results are sent. The actual HTTP request sent to this
server specifies the URL with a list of parameters that are appended to it as a query string. The
parameters include Name/Value pairs, one for each input item.
Note CiscoIPPhoneInput objects do not use the HTTP POST method.
The InputItem tag delimits each item in the list. The number of InputItems must not exceed five. Each
input item includes a DisplayName , which is the prompt that is written to the display for that particular
item. Each item also has a QueryStringParam , which is the name of the parameter that is appended to the
URL when it is sent out after input is complete. Each input item can also use the DefaultValue tag to set
the default value to be displayed.
The final attribute for each input item comprises a set of InputFlags . The following table describes the
input types that are currently defined.