Cisco Systems OL-20949-01 - page 41

3-23

Cisco Unified IP Phone Services Application Development Notes

OL-20949-01

Chapter 3 CiscoIPPhone XML Objects

Application Event Handlers

Attribute Description

appID Identifies the application to which this displayable XSI

object belongs. The format of the appID attribute should

be in the format vendor/product, such as Cisco/Unity,

but this syntax is not enforced, and the application can

assign any unique identifier.

onAppFocusLost Invoked when the application loses focus, if:

• The application’s context has lost focus, or

• The application was navigated away from, either

directly by the user, or programmatically by a refresh

header or HTTP push.

Note If a Notify URI is used as the event handler, a

notification is sent with this default data:

<notifyApplicationEvent appId="appId"

type="focusLost"/>

onAppFocusGained Invoked when the application gains focus, if:

• The application is Active and the application’s

context has gained focus, or

• The application was navigated to, either directly by

the user, or by a refresh header or HTTP push.

Note If a Notify URI is used as the event handler, a

notification is sent with this default data:

<notifyApplicationEvent appId="appId"

type="focusGained"/>

onAppMinimized Invoked when the application is minimized.

An application can only be minimized programmatically

by a call to App:Minimize, but this invocation could occur

by direct action of the user (from a softkey invocation, for

example) or from the application via a push request.

<notifyApplicationEvent appId="appId"

type="minimized"/>

onAppClosed Invoked whenever the application closes, if:

• The application's context is closed which will, in turn,

close all applications in its stack, or

• The application no longer exists on the context’s URL

stack because it was navigated out of, or because it

was pruned from the URL stack (stack size exceeded).

Note This event handler cannot contain HTTP or

HTTPS URLs.

Note If a Notify URI is used as the event handler, a

notification is sent with this default data:

<notifyApplicationEvent appId="appId"

type="closed"/>

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