Cisco Systems OL-20949-01 manual CiscoIPPhoneGraphicMenu, CiscoIPPhoneGraphicFileMenu

Page 29

Chapter 3 CiscoIPPhone XML Objects

XML Object Definitions

CiscoIPPhoneGraphicMenu

Graphic menus serve the same purpose as text menus: they allow a user to select a URL from a list. Use graphic menus in situations when the items may not be easy to display in a text list.

For example, users might prefer to have their choices presented in a non-ASCII character set such as Kanji or Arabic. When using non-ASCII character sets, the system presents the information as a bitmap graphic. To select a menu, the user enters a number from 1 to 12 using the numeric keypad (* and # are not active).

Definition

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

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.

Menu items in the graphic menu have a name, like the text menu counterparts. Although the name does not display to the user, it still performs a function. The name of the menu item provides the default title that is used when the URL for the chosen item is loaded. If the loaded page has a title of its own, the phone uses that title instead.

The XML tags in GraphicMenu use the tag definitions for CiscoIPPhoneImage and CiscoIPPhoneMenu.

Although the semantics of the tags are identical, you can have only 12 MenuItem objects in a CiscoIPPhoneGraphicMenu object. See “CiscoIPPhoneMenu” and “CiscoIPPhoneImage” for detailed descriptions.

CiscoIPPhoneGraphicFileMenu

Some of the Cisco Unified IP Phone models, such as the Cisco Unified IP Phone 7970G and

Cisco IP Communicator, have pointer devices. The Cisco Unified IP Phone 7970G uses a touchscreen overlay on the display, and the PC-based Cisco IP Communicator uses the standard Windows mouse pointer.

Because these devices can receive and process “pointer” events, a CiscoIPPhoneGraphicFileMenu object exposes the capability to application developers. The CiscoIPPhoneGraphicFileMenu behaves similar to the CiscoIPPhoneGraphicMenu, in that a group of options are presented by an image. When one of those objects is selected, a URL action initiates. However, the new FileMenu does not use the keypad, but uses rectangular touch areas. This rectangular touch area, <TouchArea>, is defined by coordinates relative to the upper-left corner of the Services display. The (X1,Y1) points specify the upper-left corner of the <TouchArea>, and (X2,Y2) specify the lower-right corner of the <TouchArea>.

 

 

Cisco Unified IP Phone Services Application Development Notes

 

 

 

 

 

 

OL-20949-01

 

 

3-11

 

 

 

 

 

Page 28 Page 30
Image 29
Page 28 Page 30
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 AudienceViii OrganizationChapter Description Related Documentation Cisco Unified Communications Manager AdministrationCisco Unified IP Phone 7900 Series Cisco Unified Communications Manager Business EditionConvention Indication Cisco Product Security OverviewDocument Conventions 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 CiscoIPPhoneExecuteCiscoIPPhoneResponse CiscoIPPhoneErrorCustom Softkeys SoftKeyItem NameDisplayed sofkey label/Name XML ConsiderationsCharacter Name Escape Sequence Mandatory Escape SequencesXML Encoding Attributes Application Event HandlersSupported Unsupported Attribute Description Event Handler Schema RTP Streaming API Component APIsApplication Management 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 6941URI Format Device Control URIsKey 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 Interaction with Call Streaming Multimedia URIsRTP Streaming URI Formats RTPRxRTPTx Interaction with Incoming Calls PlayVibrate Dial Telephony URIsSendDigits EditDialCondition Status Data Error and ResponseNotify Application Management URIsInit Called from SoftKey, with credentials, with data Called from SoftKey, no credentials, no data ApplicationAppactionpriorityidleTimerapplicationId Error and Response Http Server Requests Http Post Http Requests and Header SettingsHttp Client Requests Http GET 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 SettingCiscoIPPhoneDisplay Identifying the Capabilities of IP Phone ClientsCiscoIPPhoneModelName CiscoIPPhoneSDKVersion Accept HeaderHtml URL XML URL Accessing IP Phone InformationOL-20949-01 XML Parsing Errors Troubleshooting Cisco Unified IP Phone Service ApplicationsTroubleshooting Tips 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-410-5 Determining Problems With the InterfaceProcedure 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
Top Page Image Contents