Cisco Systems OL-20949-01 - page 34

3-16

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

The Application Status window contains three main areas: (see Figure 3-9):

• Text Ar ea

• Timer Ar e a

• Image Area

Figure 3-9 Elements of Application Status Window

Note Self-terminating XML elements, non-declared or missing elemen ts, and el ements wit h the def ault v alues

are all considered non-configured elements.

To allow dynamic sizing, do not conf i gure the Text and Timer areas with any value othe r than th e defau lt

used by the XML parser. If both elements are not configured, you can proceed, but must follow these

rules:

• Do not display the Text Area and Timer Area sections of the Application Status window.

• If the LocationX element is not configured or is set to centered, and the image provided is less than

the maximum width allowed, the Image Area can be resized.

• If the image provided is smaller than the minimum width, the mi nimu m all owed wind ow width

should be used.

• If the width of the image provided is between the minimum and maximum sizes of the window, the

window should be sized to display the image as well as the standard surrounding borders.

• The image height should never change.

See Tabl e 3-3 for an overview of the maximum and minimum image are a si zes by p hone model . M ost

phone models support all sizes between the minimum and maximum. An exception is allowed for the

Cisco Unified IP Phones 7940G/7960G due to resource constraints. For these ph ones, yo u shoul d

implement both the maximum size and minimum size windows ignoring all of the intermediate sizes.

Tab l e 3-3 Application Status Window Allowable Image Sizes

Phone Models

Maximum Image

Area Width

Minimum Image

Area Width

Maximum Image

Area Height

7940G, 7960G 106 21 21

7941G/7941G-GE, 7942G, 7945G, 7961G/7961G-GE,

7962G, 7965G

252 50 50

7970G/7971G-GE, 7975G, IP Communicator 262 50 50

Contents

Main Page CONTENTS Page Page Page Preface Overview Revision History Audience Cisco Developer Support Program Organization Related Documentation Obtaining Documentation and Submitting a Service Request Cisco Product Security Overview Document Conventions Page Page Overview Page Page Page New and Changed Information New Information for Cisco Unified Communications Manager 7.1(3) Page CiscoIPPhone XML Objects Understanding Object Behavior Page XML Object Definitions CiscoIPPhoneMenu CiscoIPPhoneText CiscoIPPhoneInput CiscoIPPhoneDirectory Custom Directories CiscoIPPhoneImage Page CiscoIPPhoneImageFile Page CiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu Page CiscoIPPhoneIconFileMenu CiscoIPPhoneStatus Page Page CiscoIPPhoneStatusFile CiscoIPPhoneExecute CiscoIPPhoneResponse CiscoIPPhoneError Custom Softkeys XML Considerations Mandatory Escape Sequences XML Encoding Application Event Handlers Page 3-24 Event Handler Schema Example Component APIs Application Management API RTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming Schema 4-3 4-4 Error Schema Examples Errors and Responses Page Internal URI Features Supported URIs by Phone Model Device Control URIs Key Key:Directories Key:Settings Unsupported Key URIs and Alternate Options Display XML Displayable Object URIs SoftKey QueryStringParam Page Multimedia URIs RTP Streaming RTPRx RTPTx RTPMRx RTPMTx Play Vibrate Telephony URIs Dial EditDial SendDigits Page Application Management URIs Init Notify Page Application Page Page HTTP Requests and Header Settings HTTP Client Requests (HTTP GET) HTTP Server Requests (HTTP POST) HTTP Header Settings HTTP Refresh Setting MIME Type and Other HTTP Headers Audio Clips Content Expiration Header Setting Set-Cookie Header Setting HTTP Encoding Header Setting Accept-Language Accept-Charset HTTP Response Headers: Content-Type Identifying the Capabilities of IP Phone Clients x-CiscoIPPhoneModelName x-CiscoIPPhoneDisplay x-CiscoIPPhoneSDKVersion Accept Header Accessing IP Phone Information Page Troubleshooting Service Applications Troubleshooting Tips XML Parsing Errors Error Messages Cisco IP Phone Services Software Development Kit (SDK) SDK Components Page Sample Services Requirements Page IP Phone Service Administration and Subscription Accessing Phone Service Administration Adding a Phone Service Defining IP Phone Service Parameters User Service Subscription DeviceListX Report Benefits Restrictions Integration Considerations and Interoperability Performance and Scalability Security Related Features and Technologies Supported Platforms Prerequisites Message and Interface Definitions Troubleshooting DeviceListX Reports Error Codes Determining Problems With the Interface Page A-1 APPENDIX A CiscoIPPhone XML Object Quick Reference Tab l e A-1 CiscoIPPhone XML Object Quick Reference A-2 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) A-3 Table A-1 CiscoIPPhone XML Object Quick Reference (continued) Page APPENDIX B Cisco Unified IP Phone Services XML Schema File Updated XML Parser and Schema Enforcement B-2 CiscoIPPhone.xsd B-3 B-4 B-5 B-6 B-7 B-8 B-9 B-10 B-11 B-12 B-13 B-14 INDEX Symbols Numerics A D E F G I M N P U X