Cisco Systems OL-20949-01 Dynamic Sizing of the Application Status Window, CiscoIPPhoneStatus

Page 33

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

The Status object cannot be closed or cleared by the user (for example, by pressing Services) because the Status object is only present on the Call plane. In order to clear the object, the phone must execute the Init:AppStatus URI. This would typically occur as the result of an application server pushing an Execute object to the phone that contains the Init:AppStatus URI.

Note The CiscoIPPhoneStatus object can only be pushed (HTTP POST) to the phone; it cannot be pulled (HTTP GET).

The CiscoIPPhoneStatus object can be refreshed or replaced at any time. It is not necessary to clear an existing Status object before sending a new Status object. The new object simply replaces the old object.

Figure 3-8shows the CiscoIPPhoneStatus object that contains the following visual elements:

•106 x 21 graphics area for displaying CIP images (same image format as CiscoIPPhoneImage)

•Seedable, free-running timer (optional)

•Single-line text area (optional)

Figure 3-8 IconMenu on a CiscoIPPhoneStatus Sample

Definition

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

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.

Dynamic Sizing of the Application Status Window

You can enable applications to dynamically adjust their window sizes based on the displayed content. The minimum size requirements limit the windows size so that it is a large enough size to stand out from the Overview content. For example, using a smaller window for an application allows more content from the Overview to be displayed. Sizing the window occurs upon the reception of a CiscoIPPhoneStatus or CiscoIPPhoneStatusFile object with its associated PNG file.

		Cisco Unified IP Phone Services Application Development Notes

	OL-20949-01			3-15
	OL-20949-01			3-15

Image 33

Contents Text Part Number OL-20949-01 Americas HeadquartersCopyright 2004-2009 Cisco Systems, Inc. All rights reserved Iii N T E N T SDisplay Init Benefits Overview PrefaceRevision History AudienceOrganization Chapter DescriptionViii Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionCisco Product Security Overview Document ConventionsConvention Indication Page Xii 1shows a sample text menu OverviewGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New Information for Cisco Unified Communications Manager New and Changed InformationOL-20949-01 Understanding Object Behavior CiscoIPPhone XML Objects1shows the supported XML objects for this release CiscoIPPhoneMenu XML Object DefinitionsDefinition CiscoIPPhoneTextSample User Input Display CiscoIPPhoneInputInputFlag Description CiscoIPPhoneDirectoryCustom Directories CiscoIPPhoneImagePacked Pixel Translation Example CiscoIPPhoneImageFile Resolution1Example ModelCisco Unified IP Phone 7970G Image File Display MonochromeCiscoIPPhoneGraphicFileMenu CiscoIPPhoneGraphicMenu5shows the display of the CiscoIPPhoneGraphicFileMenu CiscoIPPhoneIconMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneStatus CiscoIPPhoneIconFileMenuCiscoIPPhoneStatus Dynamic Sizing of the Application Status Window7962G, 7965G 7970G/7971G-GE, 7975G, IP Communicator Phone Models Area Width Area Height 7940G, 7960GCiscoIPPhoneStatusFile Phone Models WxH No Timer WxH 7940G, 7960GText Area Size 7962G, 7965GBehavior Description CiscoIPPhoneExecuteCiscoIPPhoneError Custom SoftkeysCiscoIPPhoneResponse SoftKeyItem NameDisplayed sofkey label/Name XML ConsiderationsMandatory Escape Sequences XML EncodingCharacter Name Escape Sequence Application Event Handlers Supported UnsupportedAttributes Attribute Description Event Handler Schema Component APIs Application Management APIRTP Streaming API Interaction Rules with Legacy RTP URI Streams RTP Streaming SchemaXscomplexType Xsall Error Schema Examples Errors and ResponsesStart Media Stop MediaApplicable Condition Methods Http Result Code Type Data Supported URIs by Phone Model Internal URI Features7942G, 7962G 7906G 7945G, 7965G 7970G 6921 7905G 7911G 7921G 7940G 7971G-GE 6941Device Control URIs KeyURI Format KeyDirectories Description and Alternatives Phone Unsupported ModelsURI DisplaySoftKey XML Displayable Object URIsQueryStringParam Select Exit Update Submit Search Cancel Next DialInternal URI Features XML Displayable Object URIs Multimedia URIs RTP StreamingInteraction with Call Streaming URI Formats RTPRxRTPTx Play VibrateInteraction with Incoming Calls Dial Telephony URIsSendDigits EditDialCondition Status Data Error and ResponseApplication Management URIs InitNotify Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data ApplicationAppactionpriorityidleTimerapplicationId Error and Response Http Requests and Header Settings Http Client Requests Http GETHttp Server Requests Http Post See the Http Refresh Setting section on page 6-3section Http Header SettingsRefresh Display Sample Http Refresh SettingMime Type and Other Http Headers Content Expiration Header SettingSet-Cookie Header Setting Accept-Language Http Encoding Header SettingIdentifying the Capabilities of IP Phone Clients CiscoIPPhoneModelNameCiscoIPPhoneDisplay CiscoIPPhoneSDKVersion Accept HeaderHtml URL XML URL Accessing IP Phone InformationOL-20949-01 Troubleshooting Cisco Unified IP Phone Service Applications Troubleshooting TipsXML Parsing Errors Error Messages SDK Components Cisco IP Phone Services Software Development Kit SDKOL-20949-01 \CiscoIpServices\Tools Sample Services RequirementsOL-20949-01 Accessing Phone Service Administration IP Phone Service Administration SubscriptionField Description Adding a Phone ServiceField Description Service Parameter Information Defining IP Phone Service ParametersUser Service Subscription 10-1 DeviceListX ReportRestrictions BenefitsIntegration Considerations and Interoperability Performance and ScalabilitySecurity Related Features and TechnologiesSupported Platforms PrerequisitesError Codes Troubleshooting DeviceListX ReportsField Name Description 10-4Determining Problems With the Interface Procedure10-5 10-6 Object Definition CiscoIPPhone XML Object Quick ReferenceAppendix a CiscoIPPhone XML Object Quick Reference IndexA unique index from 0 to 9/Index OL-20949-01 Updated XML Parser and Schema Enforcement Cisco Unified IP Phone Services XML Schema FileCiscoIPPhone.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 IN-1 NumericsIN-2 Html URLIN-3 IN-4 XML URL