Cisco Systems OL-20949-01 instruction

Appendix A CiscoIPPhone XML Object Quick Reference

Table A-1 CiscoIPPhone XML Object Quick Reference (continued)

Object	Definition

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>

CiscoIPPhoneGraphicMenu	<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>

CiscoIPPhoneGraphicFileMenu	<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>

Cisco Unified IP Phone Services Application Development Notes

	A-2	OL-20949-01

Image 96

Cisco Systems OL-20949-01 manual Appendix a CiscoIPPhone XML Object Quick Reference

Contents

Americas Headquarters Text Part Number OL-20949-01 Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S Iii Display Init Benefits Preface OverviewRevision History Audience Organization Chapter DescriptionViii Cisco Unified Communications Manager Administration Related DocumentationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business Edition Cisco Product Security Overview Document ConventionsConvention Indication Page Xii Overview 1shows a sample text menu Graphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications Manager OL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior 1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText Definition CiscoIPPhoneInput Sample User Input Display CiscoIPPhoneDirectory InputFlag Description CiscoIPPhoneImage Custom Directories Packed Pixel Translation Example Resolution1 CiscoIPPhoneImageFileExample Model Monochrome Cisco Unified IP Phone 7970G Image File Display CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu 6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Dynamic Sizing of the Application Status Window CiscoIPPhoneStatus Phone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models WxH No Timer WxH 7940G, 7960G CiscoIPPhoneStatusFileText Area Size 7962G, 7965G CiscoIPPhoneExecute Behavior Description CiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse XML Considerations SoftKeyItem NameDisplayed sofkey label/Name Mandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API RTP Streaming Schema Interaction Rules with Legacy RTP URI Streams XscomplexType Xsall Error Schema Errors and Responses ExamplesStart Media Stop Media Applicable Condition Methods Http Result Code Type Data Internal URI Features Supported URIs by Phone Model7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941 Device Control URIs KeyURI Format KeyDirectories Phone Unsupported Models Description and Alternatives Display URI XML Displayable Object URIs SoftKey Select Exit Update Submit Search Cancel Next Dial QueryStringParam Internal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming RTPRx URI Formats RTPTx Play VibrateInteraction with Incoming Calls Telephony URIs Dial EditDial SendDigits Error and Response Condition Status Data Application Management URIs InitNotify Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no data AppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post Http Header Settings See the Http Refresh Setting section on page 6-3section Http Refresh Setting Refresh Display Sample Content Expiration Header Setting Mime Type and Other Http Headers Set-Cookie Header Setting Http Encoding Header Setting Accept-Language Identifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay Accept Header CiscoIPPhoneSDKVersion Accessing IP Phone Information Html URL XML URL OL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit SDK SDK Components OL-20949-01 Sample Services Requirements \CiscoIpServices\Tools OL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service Administration Adding a Phone Service Field Description Defining IP Phone Service Parameters Field Description Service Parameter Information User Service Subscription DeviceListX Report 10-1 Benefits RestrictionsIntegration Considerations and Interoperability Performance and Scalability Related Features and Technologies SecuritySupported Platforms Prerequisites Troubleshooting DeviceListX Reports Error CodesField Name Description 10-4 Determining Problems With the Interface Procedure10-5 10-6 CiscoIPPhone XML Object Quick Reference Object Definition Appendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement CiscoIPPhone.xsd Xsdelement name=Name minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType XsdsimpleType xsdrestriction base=xsdstring XsdcomplexType name=CiscoIPPhoneSoftKeyType xsdsequence Xsdelement name=Title minOccurs=0 xsdsimpleType Xsdrestriction XsdsimpleType Xsdattribute XsdcomplexType Xsdelement name=CiscoIPPhoneDirectory xsdcomplexType Xsdelement name=CiscoIPPhoneImageFile xsdcomplexType Xsdelement name=CiscoIPPhoneIconMenu xsdcomplexType Xsdelement name=CiscoIPPhoneGraphicFileMenu xsdcomplexType Xsdsequence Xsdelement name=Text minOccurs=0 xsdsimpleType Xsdsequence XsdcomplexType Xsdelement Numerics IN-1 Html URL IN-2 IN-3 XML URL IN-4