YUI recommends YUI3.

YUI 2 has been deprecated since 2011. This site acts as an archive for files and documentation.

This documentation is no longer maintained.

YUI Library Examples: Connection Manager: Subscribing to Connection Manager's Custom Events via the Callback Object

Connection Manager: Subscribing to Connection Manager's Custom Events via the Callback Object

Connection Manager exposes Custom Events that track the progress of a transaction throughout its lifecycle. These Custom Events are raised at the global level and at the transaction level. The following code example provides a step-by-step approach to subscribing to transactional Custom Events raised by Connection Manager. In this scenario, an event handler object is created to handle all of the Custom Events; this event handler object is passed to Connection Manager in the callback object. Connection Manager will automatically subscribe to the events and fire the specified events.

Click "Send a Request" below to try it out, then read the description below to learn how to subscribe to transactional Custom Events in Connection Manager.

Subscribing to Connection Manager's Custom Events via the Callback Object

Source file and dependencies

Load the Yahoo Global Object and Connection Manager source files:

Create an Event Handler Object

Create an object to handle all the custom events fired by Connection Manager.

Let's create two functions to provide handlers for callback.success and callback.failure compatibility. The inclusion of these handlers will demonstrate their backward compatibility with Custom Events.

Subscribe to the transaction custom events fired by Connection Manager by creating a customevents object in the callback object. NOTE: callback.success and callback.failure are provided here to demonstrate backward compatibility, and would be redundant to customevents.onSuccess and customevents.onFailure, respectively.

Initiate the Transaction

Call YAHOO.util.Connect.asyncRequest to make a request to get.php, and PHP will return the contents of $_GET via print_r(). Each event handler in transactionObject will be triggered in response to its custom event(e.g., transactionObject.start will be called when startEvent fires). In this example, event handlers are created and subscribed to all possible events raised by Connection Manager.

Copyright © 2013 Yahoo! Inc. All rights reserved.

Privacy Policy - Copyright Policy - Job Openings