CiscoIPPhone XML Object Quick Reference

Table A-1 provides a quick reference of the CiscoIPPhone XML objects and the definitions that are associated with each.

Table A-1 CiscoIPPhone XML Object Quick Reference 

Object
Definition 
CiscoIPPhoneMenu

<CiscoIPPhoneMenu>

  <Title>Title text goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <MenuItem>

    <Name>The name of each menu item</Name>

    <URL>The URL associated with the menu item</URL>

  </MenuItem>

</CiscoIPPhoneMenu>

CiscoIPPhoneText

<CiscoIPPhoneText>

  <Title>Title text goes here</Title>

  <Prompt>The prompt text goes here</Prompt>

  <Text>Text to display as the message body goes here</Text>

</CiscoIPPhoneText>

CiscoIPPhoneInput

<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 input field to display</DisplayName>

    <QueryStringParam>The parameter to be added to the target   
URL</QueryStringParam>

    <DefaultValue>Value</DefaultValue>

    <InputFlags>The flag specifying the type of allowable 
input</InputFlags>

  </InputItem>

</CiscoIPPhoneInput>

CiscoIPPhoneDirectory

<CiscoIPPhoneDirectory>

  <Title>Directory title goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <DirectoryEntry>

    <Name>The name of the directory entry</Name>

    <Telephone>The telephone number for the entry</Telephone>

  </DirectoryEntry>

</CiscoIPPhoneDirectory>

CiscoIPPhoneImage

<CiscoIPPhoneImage>

  <Title>Image title goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <LocationX>Position information of graphic</LocationX>

  <LocationY>Position information of graphic</LocationY>

  <Width>Size information for the graphic</Width>

  <Height>Size information for the graphic</Height>

  <Depth>Number of bits per pixel</Depth>

  <Data>Packed Pixel Data</Data>

</CiscoIPPhoneImage>

CiscoIPPhoneImageFile

<CiscoIPPhoneImageFile>

  <Title>Image Title goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <LocationX>Horizontal position of graphic</LocationX>

  <LocationY>Vertical position of graphic</LocationY>

  <URL>Points to the PNG image</URL>

</CiscoIPPhoneImageFile>

CiscoIPPhoneGraphic 
Menu

<CiscoIPPhoneGraphicMenu>

  <Title>Menu title goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <LocationX>Position information of graphic</LocationX>

  <LocationY>Position information of graphic</LocationY>

  <Width>Size information for the graphic</Width>

  <Height>Size information for the graphic</Height>

  <Depth>Number of bits per pixel</Depth>

  <Data>Packed Pixel Data</Data>

  <MenuItem>

    <Name>The name of each menu item</Name>

    <URL>The URL associated with the menu item</URL>

  </MenuItem>

</CiscoIPPhoneGraphicMenu>

CiscoIPPhoneGraphic 
FileMenu

<CiscoIPPhoneGraphicFileMenu>

  <Title>Image Title goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <LocationX>Horizontal position of graphic</LocationX>

  <LocationY>Vertical position of graphic</LocationY>

  <URL>Points to the PNG background image</URL>

  <MenuItem>

    <Name>Same as CiscoIPPhoneGraphicMenu</Name>

    <URL>Invoked when the TouchArea is touched</URL>

    <TouchArea X1="left edge" Y1="top edge" X2="right 
edge"Y2="bottom edge"/>

  </MenuItem>

</CiscoIPPhoneGraphicFileMenu>

CiscoIPPhoneIconMenu

<CiscoIPPhoneIconMenu>

  <Title>Title text goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <MenuItem>

    <IconIndex>Indicates what IconItem to display</IconIndex>

    <Name>The name of each menu item</Name>

    <URL>The URL associated with the menu item</URL>

  </MenuItem>

<IconItem>

    <Index>A unique index from 0 to 9</Index>

    <Height>Size information for the icon</Height>

    <Width>Size information for the icon</Width>

    <Depth>Number of bits per pixel</Depth>

    <Data>Packed Pixel Data</Data>

  </IconItem>

</CiscoIPPhoneIconMenu>

CiscoIPPhoneIconFile 
Menu

<CiscoIPPhoneIconFileMenu>

  <Title>Title text goes here</Title>

  <Prompt>Prompt text goes here</Prompt>

  <MenuItem>

    <IconIndex>Indicates what IconItem to display</IconIndex>

    <Name>The name of each menu item</Name>

    <URL>The URL associated with the menu item</URL>

  </MenuItem>

  <IconItem>

    <Index>A unique index from 0 to 9</Index>

    <URL>location of the PNG icon image</URL>

  </IconItem>

</CiscoIPPhoneIconFileMenu>

CiscoIPPhoneStatus

<CiscoIPPhoneStatus>

  <Text>This is the text area</Text>

  <Timer>Timer seed value in seconds</Timer>

  <LocationX>Horizontal alignment</LocationX>

  <LocationY>Vertical alignment</LocationY>

  <Width>Pixel width of graphic</Width>

  <Height>Pixel height of graphic</Height>

  <Depth>Color depth in bits</Depth>

  <Data>Hex binary image data</Data>

</CiscoIPPhoneStatus>

CiscoIPPhoneStatusFile

<CiscoIPPhoneStatusFile>

<Text>This is the text area</Text>

<Timer>Timer seed value in seconds</Timer>

<LocationX>Horizontal alignment</LocationX>

<LocationY>Vertical alignment</LocationY>

<URL>location of the PNG image</URL>

</CiscoIPPhoneStatusFile>

CiscoIPPhoneExecute

<CiscoIPPhoneExecute>

  <ExecuteItem URL="The URL or URI to be executed"/>

</CiscoIPPhoneExecute>

CiscoIPPhoneError

<CiscoIPPhoneError Number="x"/>

CiscoIPPhoneResponse

<CiscoIPPhoneResponse>

  <ResponseItem Status"the success or failure of the 
action"Data="the information associated with the request" 
URL="the URL or URI specified in the Execute object"/>

</CiscoIPPhoneResponse>