Cisco Systems OL-20949-01 manual CiscoIPPhoneIconFileMenu, CiscoIPPhoneStatus

Page 32

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

CiscoIPPhoneIconFileMenu

This icon menu is similar to CiscoIPPhoneMenu, but it uses color PNG icons rather than grayscale CIP icons. Use icon menus in situations when you want to provide additional visual information to the user to show the state or category of an item. For example, you can use icons to indicate priority (see Figure 3-7).

Icons in the CiscoIPPhoneIconFileMenu object have a maximum width of 18 pixels and a maximum height of 18 pixels. Instead of using the <Data> tag to embed the image data into the <IconItem> tag, this object uses a <URL> tag to point to the PNG image file to be used for that icon.

Figure 3-7 CiscoIPPhoneIconFileMenu Object Display Sample

Definition

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

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.

CiscoIPPhoneStatus

The CiscoIPPhoneStatus object is also a displayable object, but differs from the preceding objects in that it displays on the Call plane of the phone rather than the Services plane. The CiscoIPPhoneStatus object “hovers” above the Call plane and is typically used in conjunction with CTI applications to present application status to the user.

	Cisco Unified IP Phone Services Application Development Notes
3-14	OL-20949-01

Image 32

Contents Americas Headquarters Text Part Number OL-20949-01Copyright 2004-2009 Cisco Systems, Inc. All rights reserved N T E N T S IiiDisplay Init Benefits Preface OverviewRevision History AudienceViii OrganizationChapter Description Cisco Unified Communications Manager Administration Related DocumentationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionConvention Indication Cisco Product Security OverviewDocument Conventions Page Xii Overview 1shows a sample text menuGraphic Menu on a Cisco Unified IP Phone Sample Page OL-20949-01 New and Changed Information New Information for Cisco Unified Communications ManagerOL-20949-01 CiscoIPPhone XML Objects Understanding Object Behavior1shows the supported XML objects for this release XML Object Definitions CiscoIPPhoneMenuCiscoIPPhoneText DefinitionCiscoIPPhoneInput Sample User Input DisplayCiscoIPPhoneDirectory InputFlag DescriptionCiscoIPPhoneImage Custom DirectoriesPacked Pixel Translation Example Resolution1 CiscoIPPhoneImageFileExample ModelMonochrome Cisco Unified IP Phone 7970G Image File DisplayCiscoIPPhoneGraphicMenu CiscoIPPhoneGraphicFileMenuCiscoIPPhoneIconMenu 5shows the display of the CiscoIPPhoneGraphicFileMenu6shows an IconMenu on a Cisco Unified IP Phone CiscoIPPhoneIconFileMenu CiscoIPPhoneStatusDynamic Sizing of the Application Status Window CiscoIPPhoneStatusPhone Models Area Width Area Height 7940G, 7960G 7962G, 7965G 7970G/7971G-GE, 7975G, IP CommunicatorPhone Models WxH No Timer WxH 7940G, 7960G CiscoIPPhoneStatusFileText Area Size 7962G, 7965GCiscoIPPhoneExecute Behavior DescriptionCiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys XML Considerations SoftKeyItem NameDisplayed sofkey label/NameCharacter Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management API RTP Streaming Schema Interaction Rules with Legacy RTP URI StreamsXscomplexType Xsall Error Schema Errors and Responses ExamplesStart Media Stop MediaApplicable 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 6941URI Format Device Control URIsKey KeyDirectories Phone Unsupported Models Description and AlternativesDisplay URIXML Displayable Object URIs SoftKeySelect Exit Update Submit Search Cancel Next Dial QueryStringParamInternal URI Features XML Displayable Object URIs Interaction with Call Streaming Multimedia URIsRTP Streaming RTPRx URI FormatsRTPTx Interaction with Incoming Calls PlayVibrate Telephony URIs DialEditDial SendDigitsError and Response Condition Status DataNotify Application Management URIsInit Called from SoftKey, with credentials, with data Application Called from SoftKey, no credentials, no dataAppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET Http Header Settings See the Http Refresh Setting section on page 6-3sectionHttp Refresh Setting Refresh Display SampleContent Expiration Header Setting Mime Type and Other Http HeadersSet-Cookie Header Setting Http Encoding Header Setting Accept-LanguageCiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName Accept Header CiscoIPPhoneSDKVersionAccessing IP Phone Information Html URL XML URLOL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips Error Messages Cisco IP Phone Services Software Development Kit SDK SDK ComponentsOL-20949-01 Sample Services Requirements \CiscoIpServices\ToolsOL-20949-01 IP Phone Service Administration Subscription Accessing Phone Service AdministrationAdding a Phone Service Field DescriptionDefining IP Phone Service Parameters Field Description Service Parameter InformationUser Service Subscription DeviceListX Report 10-1Benefits RestrictionsIntegration Considerations and Interoperability Performance and ScalabilityRelated Features and Technologies SecuritySupported Platforms PrerequisitesTroubleshooting DeviceListX Reports Error CodesField Name Description 10-410-5 Determining Problems With the InterfaceProcedure 10-6 CiscoIPPhone XML Object Quick Reference Object DefinitionAppendix 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 EnforcementCiscoIPPhone.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-1Html URL IN-2IN-3 XML URL IN-4