<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: io io (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<link rel="stylesheet" type="text/css" href="assets/api.css" />
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>io <span class="subtitle">3.0.0</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
> <a href="./module_io.html" title="io">io</a>
> io
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">io</b>
<span class="extends">
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
The io class is a utility that brokers HTTP requests through a simplified
interface. Specifically, it allows JavaScript to make HTTP requests to
a resource without a page reload. The underlying transport for making
same-domain requests is the XMLHttpRequest object. YUI.io can also use
Flash, if specified as a transport, for cross-domain requests.
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private" rel="yui:property" resource="#property__e">
<h4><a name="property__e" property="yui:name">_e</a>
- <code>private static <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Reference to "io:complete" event handler.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__fn">
<h4><a name="property__fn" property="yui:name">_fn</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object that stores callback handlers for cross-domain requests
when using Flash as the transport.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__headers">
<h4><a name="property__headers" property="yui:name">_headers</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object of default HTTP headers to be initialized and sent
for all transactions.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__qState">
<h4><a name="property__qState" property="yui:name">_qState</a>
- <code>private static <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Property to determine whether the queue is set to
1 (active) or 0 (inactive). When inactive, transactions
will be stored in the queue until the queue is set to active.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__rS">
<h4><a name="property__rS" property="yui:name">_rS</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Map of transaction state used when XDomainRequest is the
XDR transport.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__timeout">
<h4><a name="property__timeout" property="yui:name">_timeout</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object that stores timeout values for any transaction with
a defined "timeout" configuration property.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__transport">
<h4><a name="property__transport" property="yui:name">_transport</a>
- <code>private static <span property="yui:type">object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Map of io transports.
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__yQ">
<h4><a name="property__yQ" property="yui:name">_yQ</a>
- <code>private static <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Array of transactions queued for processing
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property_transactionId">
<h4><a name="property_transactionId" property="yui:name">transactionId</a>
- <code>private static <span property="yui:type">int</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
A transaction counter that increments for each transaction.
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__abort">
<h4>
<a name="method__abort">_abort</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_abort</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Method for intiating an XDR transaction abort.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__clearTimeout">
<h4>
<a name="method__clearTimeout">_clearTimeout</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_clearTimeout</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Clears the timeout interval started by _startTimeout().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - Transaction id.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__concat">
<h4>
<a name="method__concat">_concat</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_concat</strong>
(
s
,
d
)
</code>
<div class="description" property="yui:description">
Method that concatenates string data for HTTP GET transactions.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">s</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - URI or root data.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">d</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - data to be concatenated onto URI.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">int</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__create">
<h4>
<a name="method__create">_create</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_create</strong>
(
c
,
i
)
</code>
<div class="description" property="yui:description">
Method that creates a unique transaction object for each
request.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - configuration object subset to determine if
the transaction is an XDR or file upload,
requiring an alternate transport.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">i</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - transaction id</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__data">
<h4>
<a name="method__data">_data</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_data</strong>
(
o
,
isFlash
,
isXML
)
</code>
<div class="description" property="yui:description">
Creates a response object for XDR transactions, for success
and failure cases.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">isFlash</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> - True if Flash was used as the transport.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">isXML</span>
<<span property="yui:type">boolean</span>>
</code>
<span property="yui:description"> - True if the response data are XML.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__destroy">
<h4>
<a name="method__destroy">_destroy</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_destroy</strong>
(
o
,
uri
,
c
)
</code>
<div class="description" property="yui:description">
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">o</span>>
</code>
<span property="yui:description"> The transaction object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Qualified path to transaction resource.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Configuration object for the transaction.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__handle">
<h4>
<a name="method__handle">_handle</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_handle</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Bound to the iframe's Load event and processes
the response data.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">o</span>>
</code>
<span property="yui:description"> The transaction object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Configuration object for the transaction.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__handleResponse">
<h4>
<a name="method__handleResponse">_handleResponse</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_handleResponse</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Method that determines if a transaction response qualifies
as success or failure, based on the response HTTP status code, and
fires the appropriate success or failure events.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create().</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Configuration object passed to io().</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__id">
<h4>
<a name="method__id">_id</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_id</strong>
(
)
</code>
<div class="description" property="yui:description">
Method that increments _transactionId for each transaction.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">int</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__io">
<h4>
<a name="method__io">_io</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_io</strong>
(
uri
,
c
,
i
)
</code>
<div class="description" property="yui:description">
Method for requesting a transaction. _io() is implemented as
yui.io(). Each transaction may include a configuration object. Its
properties are:
method: HTTP method verb (e.g., GET or POST). If this property is not
not defined, the default value will be GET.
data: This is the name-value string that will be sent as the transaction
data. If the request is HTTP GET, the data become part of
querystring. If HTTP POST, the data are sent in the message body.
xdr: Defines the transport to be used for cross-domain requests. By
setting this property, the transaction will use the specified
transport instead of XMLHttpRequest. Currently, the only alternate
transport supported is Flash (e.g., { xdr: 'flash' }).
form: This is a defined object used to process HTML form as data. The
properties are:
{
id: object, //HTML form object or id of HTML form
useDisabled: boolean, //Allow disabled HTML form field values
to be sent as part of the data.
}
on: This is a defined object used to create and handle specific
events during a transaction lifecycle. These events will fire in
addition to the global io events. The events are:
start - This event is fired when a request is sent to a resource.
complete - This event fires when the transaction is complete.
success - This event fires when the response status resolves to
HTTP 2xx.
failure - This event fires when the response status resolves to
HTTP 4xx, 5xx; and, for all transaction exceptions,
including aborted transactions and transaction timeouts.
end - This even is fired at the conclusion of the transaction
lifecycle, after a success or failure resolution.
The properties are:
{
start: function(id, args){},
complete: function(id, responseobject, args){},
success: function(id, responseobject, args){},
failure: function(id, responseobject, args){},
end: function(id, args){}
}
Each property can reference a function or be written as an
inline function.
context: Object reference for an event handler when it is implemented
as a method of a base object. Defining "context" will preserve
the proper reference of "this" used in the event handler.
headers: This is a defined object of client headers, as many as.
desired for the transaction. These headers are sentThe object
pattern is:
{
header: value
}
timeout: This value, defined as milliseconds, is a time threshold for the
transaction. When this threshold is reached, and the transaction's
Complete event has not yet fired, the transaction will be aborted.
arguments: Object, array, string, or number passed to all registered
event handlers. This value is available as the second
argument in the "start" and "abort" event handlers; and, it is
the third argument in the "complete", "success", and "failure"
event handlers.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - qualified path to transaction resource.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">i</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - transaction id, if already set by queue.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioCancel">
<h4>
<a name="method__ioCancel">_ioCancel</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioCancel</strong>
(
o
,
s
)
</code>
<div class="description" property="yui:description">
Terminates a transaction due to an explicit abort or
timeout.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create().</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">s</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - Identifies timed out or aborted transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioComplete">
<h4>
<a name="method__ioComplete">_ioComplete</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioComplete</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:complete" and creates, fires a
transaction-specific "complete" event, if config.on.complete is
defined.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - transaction object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioEnd">
<h4>
<a name="method__ioEnd">_ioEnd</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioEnd</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:end" and creates, fires a
transaction-specific "end" event, if config.on.end is
defined.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - transaction object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioFailure">
<h4>
<a name="method__ioFailure">_ioFailure</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioFailure</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:failure" and creates, fires a
transaction-specific "failure" event, if config.on.failure is
defined.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - transaction object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioStart">
<h4>
<a name="method__ioStart">_ioStart</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioStart</strong>
(
id
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:start" and creates, fires a
transaction-specific start event, if config.on.start is
defined.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - transaction id</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__ioSuccess">
<h4>
<a name="method__ioSuccess">_ioSuccess</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_ioSuccess</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:success" and creates, fires a
transaction-specific "success" event, if config.on.success is
defined.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - transaction object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__isInProgress.">
<h4>
<a name="method__isInProgress.">_isInProgress.</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_isInProgress.</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Method for determining if an XDR transaction has completed
and all data are received.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__queue">
<h4>
<a name="method__queue">_queue</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_queue</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for requesting a transaction, and queueing the
request before it is sent to the resource.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">Object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__readyState">
<h4>
<a name="method__readyState">_readyState</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_readyState</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Event handler bound to onreadystatechange.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create().</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__remove">
<h4>
<a name="method__remove">_remove</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_remove</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for removing a specific, pending transaction from
the queue.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__resend">
<h4>
<a name="method__resend">_resend</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_resend</strong>
(
o
,
uri
,
c
)
</code>
<div class="description" property="yui:description">
Resends an XDR transaction, using the Flash tranport,
if the native transport fails.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create().</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - qualified path to transaction resource.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__resetAttrs">
<h4>
<a name="method__resetAttrs">_resetAttrs</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_resetAttrs</strong>
(
f
,
a
)
</code>
<div class="description" property="yui:description">
Sets the appropriate attributes and values to the HTML
form, in preparation of a file upload transaction.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">f</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> HTML form object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">a</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Object of original attributes.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__serialize">
<h4>
<a name="method__serialize">_serialize</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_serialize</strong>
(
c
,
s
)
</code>
<div class="description" property="yui:description">
Method to enumerate through an HTML form's elements collection
and return a string comprised of key-value pairs.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - YUI form node or HTML form id.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">s</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - Transaction data defined in the configuration.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">string</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setAttrs">
<h4>
<a name="method__setAttrs">_setAttrs</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_setAttrs</strong>
(
f
,
id
,
uri
)
</code>
<div class="description" property="yui:description">
Sets the appropriate attributes and values to the HTML
form, in preparation of a file upload transaction.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">f</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> HTML form object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> The Transaction ID.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Qualified path to transaction resource.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setHeader">
<h4>
<a name="method__setHeader">_setHeader</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_setHeader</strong>
(
l
,
v
)
</code>
<div class="description" property="yui:description">
Method that stores default client headers for all transactions.
If a label is passed with no value argument, the header will be deleted.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">l</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - HTTP header</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">v</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - HTTP header value</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">int</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__setHeaders">
<h4>
<a name="method__setHeaders">_setHeaders</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_setHeaders</strong>
(
o
,
h
)
</code>
<div class="description" property="yui:description">
Method that sets all HTTP headers to be sent in a transaction.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - XHR instance for the specific transaction.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">h</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - HTTP headers for the specific transaction, as defined
in the configuration object passed to YUI.io().</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__shift">
<h4>
<a name="method__shift">_shift</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_shift</strong>
(
)
</code>
<div class="description" property="yui:description">
Method Process the first transaction from the
queue in FIFO order.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__size">
<h4>
<a name="method__size">_size</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_size</strong>
(
)
</code>
<div class="description" property="yui:description">
Method to query the current size of the queue.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">int</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__startTimeout">
<h4>
<a name="method__startTimeout">_startTimeout</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_startTimeout</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Starts timeout count if the configuration object
has a defined timeout property.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create().</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__stop">
<h4>
<a name="method__stop">_stop</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_stop</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for setting queue processing to inactive.
Transaction requests to YUI.io.queue() will be stored in the queue, but
not processed until the queue is reset to "active".
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__subscribe">
<h4>
<a name="method__subscribe">_subscribe</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_subscribe</strong>
(
e
,
c
)
</code>
<div class="description" property="yui:description">
Method for creating and subscribing transaction events.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - event to be published</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration data subset for event subscription.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__swf">
<h4>
<a name="method__swf">_swf</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_swf</strong>
(
uri
,
yid
)
</code>
<div class="description" property="yui:description">
Method that creates the Flash transport swf.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - location of io.swf.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">yid</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - YUI instance id.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__unshift">
<h4>
<a name="method__unshift">_unshift</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_unshift</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for promoting a transaction to the top of the queue.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__upload">
<h4>
<a name="method__upload">_upload</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">_upload</strong>
(
o
,
uri
,
c
)
</code>
<div class="description" property="yui:description">
Uploads HTML form data, inclusive of files/attachments,
using the iframe created in _create to facilitate the transaction.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">o</span>>
</code>
<span property="yui:description"> The transaction object</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Qualified path to transaction resource.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> Configuration object for the transaction.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__xdr">
<h4>
<a name="method__xdr">_xdr</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_xdr</strong>
(
o
,
c
)
</code>
<div class="description" property="yui:description">
Sets event handlers for XDomainRequest transactions.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__xhr">
<h4>
<a name="method__xhr">_xhr</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">_xhr</strong>
(
)
</code>
<div class="description" property="yui:description">
Method that creates the XMLHttpRequest transport
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_appendData">
<h4>
<a name="method_appendData">appendData</a></h4>
<div class="detail" >
<code>
private
static
array
<strong property="yui:name">appendData</strong>
(
f
,
s
)
</code>
<div class="description" property="yui:description">
Parses the POST data object and creates hidden form elements
for each key-value, and appends them to the HTML form object.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">f</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> HTML form object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">s</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> The key-value POST data.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
array
</code></dt>
<dd property="yui:returnInfo">e Array of created fields.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_f">
<h4>
<a name="method_f">f</a></h4>
<div class="detail" >
<code>
private
static
void
<strong property="yui:name">f</strong>
(
f
,
o
)
</code>
<div class="description" property="yui:description">
Removes the custom fields created to pass additional POST
data, along with the HTML form fields.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">f</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> HTML form object.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> HTML form fields created from configuration.data.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_header">
<h4>
<a name="method_header">header</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">header</strong>
(
l
,
v
)
</code>
<div class="description" property="yui:description">
Method that stores default client headers for all transactions.
If a label is passed with no value argument, the header will be deleted.
This is the interface for _setHeader().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">l</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - HTTP header</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">v</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - HTTP header value</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">int</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_io">
<h4>
<a name="method_io">io</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">io</strong>
(
uri
,
c
)
</code>
<div class="description" property="yui:description">
Method for requesting a transaction. This
is the interface for _io().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">uri</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - qualified path to transaction resource.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_promote">
<h4>
<a name="method_promote">promote</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">promote</strong>
(
o
)
</code>
<div class="description" property="yui:description">
Method for promoting a transaction to the top of the queue.
This is the interface for _unshift().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> - Reference to queued transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_remove">
<h4>
<a name="method_remove">remove</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">remove</strong>
(
o
)
</code>
<div class="description" property="yui:description">
Method for removing a specific, pending transaction from
the queue. This is the interface for _remove().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">Object</span>>
</code>
<span property="yui:description"> - Reference to queued transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_size">
<h4>
<a name="method_size">size</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">size</strong>
(
i
)
</code>
<div class="description" property="yui:description">
Method to query the current size of the queue, or to
set a maximum queue size. This is the interface for _size().
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">i</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - Specified maximum size of queue.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">number</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_start">
<h4>
<a name="method_start">start</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">start</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for setting the queue to active. If there are
transactions pending in the queue, they will be processed from the
queue in FIFO order. This is the interface for _start().
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_stop">
<h4>
<a name="method_stop">stop</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">stop</strong>
(
)
</code>
<div class="description" property="yui:description">
Method for setting queue processing to inactive.
Transaction requests to YUI.io.queue() will be stored in the queue, but
not processed until the queue is restarted. This is the
interface for _stop().
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_transport">
<h4>
<a name="method_transport">transport</a></h4>
<div class="detail" >
<code>
static
<strong property="yui:name">transport</strong>
(
o
)
</code>
<div class="description" property="yui:description">
Method to initialize the desired transport.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - object of transport configurations.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_xdrReady">
<h4>
<a name="method_xdrReady">xdrReady</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">xdrReady</strong>
(
id
,
c
)
</code>
<div class="description" property="yui:description">
Fires event "io:xdrReady"
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
<<span property="yui:type">number</span>>
</code>
<span property="yui:description"> - transaction id</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">void</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method_xdrResponse">
<h4>
<a name="method_xdrResponse">xdrResponse</a></h4>
<div class="detail" >
<code>
private
static
<strong property="yui:name">xdrResponse</strong>
(
o
,
c
,
e
)
</code>
<div class="description" property="yui:description">
Response controller for cross-domain requests when using the
Flash transport or IE8's XDomainRequest object.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">c</span>
<<span property="yui:type">object</span>>
</code>
<span property="yui:description"> - configuration object for the transaction.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">e</span>
<<span property="yui:type">string</span>>
</code>
<span property="yui:description"> - Event name</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
</code></dt>
<dd property="yui:returnInfo">object</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_io:complete">
<h4>
<a name="event_io:complete">io:complete</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:complete</strong>
(
)
</code>
<div class="description" property="yui:description">
This event is fired by YUI.io when a transaction is complete.
Response status and data are accessible, if available.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_io:end">
<h4>
<a name="event_io:end">io:end</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:end</strong>
(
)
</code>
<div class="description" property="yui:description">
This event signifies the end of the transaction lifecycle. The
transaction transport is destroyed.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_io:failure">
<h4>
<a name="event_io:failure">io:failure</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:failure</strong>
(
)
</code>
<div class="description" property="yui:description">
This event is fired by YUI.io when a transaction is complete, and
the HTTP status resolves to HTTP4xx, 5xx and above.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_io:start">
<h4>
<a name="event_io:start">io:start</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:start</strong>
(
)
</code>
<div class="description" property="yui:description">
This event is fired by YUI.io when a transaction is initiated.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_io:success">
<h4>
<a name="event_io:success">io:success</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:success</strong>
(
)
</code>
<div class="description" property="yui:description">
This event is fired by YUI.io when a transaction is complete, and
the HTTP status resolves to HTTP2xx.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_io:xdrReady">
<h4>
<a name="event_io:xdrReady">io:xdrReady</a></h4>
<div class="detail">
<code>
<strong property="yui:name">io:xdrReady</strong>
(
)
</code>
<div class="description" property="yui:description">
This event is fired by YUI.io when the specified transport is
ready for use.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
<li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
<li class=""><a href="module_base.html" title="base">base</a></li>
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
<li class=""><a href="module_console.html" title="console">console</a></li>
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class="selected"><a href="module_io.html" title="io">io</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_node.html" title="node">node</a></li>
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
<li class=""><a href="module_test.html" title="test">test</a></li>
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class="selected"><a href="io.html" title="io">io</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="io-base.js.html" title="io-base.js">io-base.js</a></li>
<li class=""><a href="io-form.js.html" title="io-form.js">io-form.js</a></li>
<li class=""><a href="io-queue.js.html" title="io-queue.js">io-queue.js</a></li>
<li class=""><a href="io-upload-iframe.js.html" title="io-upload-iframe.js">io-upload-iframe.js</a></li>
<li class=""><a href="io-xdr.js.html" title="io-xdr.js">io-xdr.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property__e" title="_e">_e</a></li>
<li class="private"><a href="#property__fn" title="_fn">_fn</a></li>
<li class="private"><a href="#property__headers" title="_headers">_headers</a></li>
<li class="private"><a href="#property__qState" title="_qState">_qState</a></li>
<li class="private"><a href="#property__rS" title="_rS">_rS</a></li>
<li class="private"><a href="#property__timeout" title="_timeout">_timeout</a></li>
<li class="private"><a href="#property__transport" title="_transport">_transport</a></li>
<li class="private"><a href="#property__yQ" title="_yQ">_yQ</a></li>
<li class="private"><a href="#property_transactionId" title="transactionId">transactionId</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__abort" title="_abort">_abort</a></li>
<li class="private"><a href="#method__clearTimeout" title="_clearTimeout">_clearTimeout</a></li>
<li class="private"><a href="#method__concat" title="_concat">_concat</a></li>
<li class="private"><a href="#method__create" title="_create">_create</a></li>
<li class="private"><a href="#method__data" title="_data">_data</a></li>
<li class="private"><a href="#method__destroy" title="_destroy">_destroy</a></li>
<li class="private"><a href="#method__handle" title="_handle">_handle</a></li>
<li class="private"><a href="#method__handleResponse" title="_handleResponse">_handleResponse</a></li>
<li class="private"><a href="#method__id" title="_id">_id</a></li>
<li class="private"><a href="#method__io" title="_io">_io</a></li>
<li class="private"><a href="#method__ioCancel" title="_ioCancel">_ioCancel</a></li>
<li class="private"><a href="#method__ioComplete" title="_ioComplete">_ioComplete</a></li>
<li class="private"><a href="#method__ioEnd" title="_ioEnd">_ioEnd</a></li>
<li class="private"><a href="#method__ioFailure" title="_ioFailure">_ioFailure</a></li>
<li class="private"><a href="#method__ioStart" title="_ioStart">_ioStart</a></li>
<li class="private"><a href="#method__ioSuccess" title="_ioSuccess">_ioSuccess</a></li>
<li class="private"><a href="#method__isInProgress." title="_isInProgress.">_isInProgress.</a></li>
<li class="private"><a href="#method__queue" title="_queue">_queue</a></li>
<li class="private"><a href="#method__readyState" title="_readyState">_readyState</a></li>
<li class="private"><a href="#method__remove" title="_remove">_remove</a></li>
<li class="private"><a href="#method__resend" title="_resend">_resend</a></li>
<li class="private"><a href="#method__resetAttrs" title="_resetAttrs">_resetAttrs</a></li>
<li class="private"><a href="#method__serialize" title="_serialize">_serialize</a></li>
<li class="private"><a href="#method__setAttrs" title="_setAttrs">_setAttrs</a></li>
<li class="private"><a href="#method__setHeader" title="_setHeader">_setHeader</a></li>
<li class="private"><a href="#method__setHeaders" title="_setHeaders">_setHeaders</a></li>
<li class="private"><a href="#method__shift" title="_shift">_shift</a></li>
<li class="private"><a href="#method__size" title="_size">_size</a></li>
<li class="private"><a href="#method__startTimeout" title="_startTimeout">_startTimeout</a></li>
<li class="private"><a href="#method__stop" title="_stop">_stop</a></li>
<li class="private"><a href="#method__subscribe" title="_subscribe">_subscribe</a></li>
<li class="private"><a href="#method__swf" title="_swf">_swf</a></li>
<li class="private"><a href="#method__unshift" title="_unshift">_unshift</a></li>
<li class="private"><a href="#method__upload" title="_upload">_upload</a></li>
<li class="private"><a href="#method__xdr" title="_xdr">_xdr</a></li>
<li class="private"><a href="#method__xhr" title="_xhr">_xhr</a></li>
<li class="private"><a href="#method_appendData" title="appendData">appendData</a></li>
<li class="private"><a href="#method_f" title="f">f</a></li>
<li class=""><a href="#method_header" title="header">header</a></li>
<li class=""><a href="#method_io" title="io">io</a></li>
<li class=""><a href="#method_promote" title="promote">promote</a></li>
<li class=""><a href="#method_remove" title="remove">remove</a></li>
<li class=""><a href="#method_size" title="size">size</a></li>
<li class=""><a href="#method_start" title="start">start</a></li>
<li class=""><a href="#method_stop" title="stop">stop</a></li>
<li class=""><a href="#method_transport" title="transport">transport</a></li>
<li class="private"><a href="#method_xdrReady" title="xdrReady">xdrReady</a></li>
<li class="private"><a href="#method_xdrResponse" title="xdrResponse">xdrResponse</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_io:complete" title="io:complete">io:complete</a></li>
<li class=""><a href="#event_io:end" title="io:end">io:end</a></li>
<li class=""><a href="#event_io:failure" title="io:failure">io:failure</a></li>
<li class=""><a href="#event_io:start" title="io:start">io:start</a></li>
<li class=""><a href="#event_io:success" title="io:success">io:success</a></li>
<li class=""><a href="#event_io:xdrReady" title="io:xdrReady">io:xdrReady</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright © 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "private", "host": "io", "name": "_abort", "url": "io.html#method__abort", "type": "method"}, {"access": "private", "host": "io", "name": "appendData", "url": "io.html#method_appendData", "type": "method"}, {"access": "private", "host": "io", "name": "_clearTimeout", "url": "io.html#method__clearTimeout", "type": "method"}, {"access": "private", "host": "io", "name": "_concat", "url": "io.html#method__concat", "type": "method"}, {"access": "private", "host": "io", "name": "_create", "url": "io.html#method__create", "type": "method"}, {"access": "private", "host": "io", "name": "_data", "url": "io.html#method__data", "type": "method"}, {"access": "private", "host": "io", "name": "_destroy", "url": "io.html#method__destroy", "type": "method"}, {"access": "private", "host": "io", "name": "_e", "url": "io.html#property__e", "type": "property"}, {"access": "private", "host": "io", "name": "f", "url": "io.html#method_f", "type": "method"}, {"access": "private", "host": "io", "name": "_fn", "url": "io.html#property__fn", "type": "property"}, {"access": "private", "host": "io", "name": "_handle", "url": "io.html#method__handle", "type": "method"}, {"access": "private", "host": "io", "name": "_handleResponse", "url": "io.html#method__handleResponse", "type": "method"}, {"access": "", "host": "io", "name": "header", "url": "io.html#method_header", "type": "method"}, {"access": "private", "host": "io", "name": "_headers", "url": "io.html#property__headers", "type": "property"}, {"access": "private", "host": "io", "name": "_id", "url": "io.html#method__id", "type": "method"}, {"access": "private", "host": "io", "name": "_io", "url": "io.html#method__io", "type": "method"}, {"access": "", "host": "io", "name": "io", "url": "io.html#method_io", "type": "method"}, {"access": "", "host": "io", "name": "io:complete", "url": "io.html#event_io:complete", "type": "event"}, {"access": "", "host": "io", "name": "io:end", "url": "io.html#event_io:end", "type": "event"}, {"access": "", "host": "io", "name": "io:failure", "url": "io.html#event_io:failure", "type": "event"}, {"access": "", "host": "io", "name": "io:start", "url": "io.html#event_io:start", "type": "event"}, {"access": "", "host": "io", "name": "io:success", "url": "io.html#event_io:success", "type": "event"}, {"access": "", "host": "io", "name": "io:xdrReady", "url": "io.html#event_io:xdrReady", "type": "event"}, {"access": "private", "host": "io", "name": "_ioCancel", "url": "io.html#method__ioCancel", "type": "method"}, {"access": "private", "host": "io", "name": "_ioComplete", "url": "io.html#method__ioComplete", "type": "method"}, {"access": "private", "host": "io", "name": "_ioEnd", "url": "io.html#method__ioEnd", "type": "method"}, {"access": "private", "host": "io", "name": "_ioFailure", "url": "io.html#method__ioFailure", "type": "method"}, {"access": "private", "host": "io", "name": "_ioStart", "url": "io.html#method__ioStart", "type": "method"}, {"access": "private", "host": "io", "name": "_ioSuccess", "url": "io.html#method__ioSuccess", "type": "method"}, {"access": "private", "host": "io", "name": "_isInProgress.", "url": "io.html#method__isInProgress.", "type": "method"}, {"access": "", "host": "io", "name": "promote", "url": "io.html#method_promote", "type": "method"}, {"access": "private", "host": "io", "name": "_qState", "url": "io.html#property__qState", "type": "property"}, {"access": "private", "host": "io", "name": "_queue", "url": "io.html#method__queue", "type": "method"}, {"access": "private", "host": "io", "name": "_readyState", "url": "io.html#method__readyState", "type": "method"}, {"access": "private", "host": "io", "name": "_remove", "url": "io.html#method__remove", "type": "method"}, {"access": "", "host": "io", "name": "remove", "url": "io.html#method_remove", "type": "method"}, {"access": "private", "host": "io", "name": "_resend", "url": "io.html#method__resend", "type": "method"}, {"access": "private", "host": "io", "name": "_resetAttrs", "url": "io.html#method__resetAttrs", "type": "method"}, {"access": "private", "host": "io", "name": "_rS", "url": "io.html#property__rS", "type": "property"}, {"access": "private", "host": "io", "name": "_serialize", "url": "io.html#method__serialize", "type": "method"}, {"access": "private", "host": "io", "name": "_setAttrs", "url": "io.html#method__setAttrs", "type": "method"}, {"access": "private", "host": "io", "name": "_setHeader", "url": "io.html#method__setHeader", "type": "method"}, {"access": "private", "host": "io", "name": "_setHeaders", "url": "io.html#method__setHeaders", "type": "method"}, {"access": "private", "host": "io", "name": "_shift", "url": "io.html#method__shift", "type": "method"}, {"access": "private", "host": "io", "name": "_size", "url": "io.html#method__size", "type": "method"}, {"access": "", "host": "io", "name": "size", "url": "io.html#method_size", "type": "method"}, {"access": "", "host": "io", "name": "start", "url": "io.html#method_start", "type": "method"}, {"access": "private", "host": "io", "name": "_startTimeout", "url": "io.html#method__startTimeout", "type": "method"}, {"access": "private", "host": "io", "name": "_stop", "url": "io.html#method__stop", "type": "method"}, {"access": "", "host": "io", "name": "stop", "url": "io.html#method_stop", "type": "method"}, {"access": "private", "host": "io", "name": "_subscribe", "url": "io.html#method__subscribe", "type": "method"}, {"access": "private", "host": "io", "name": "_swf", "url": "io.html#method__swf", "type": "method"}, {"access": "private", "host": "io", "name": "_timeout", "url": "io.html#property__timeout", "type": "property"}, {"access": "private", "host": "io", "name": "transactionId", "url": "io.html#property_transactionId", "type": "property"}, {"access": "private", "host": "io", "name": "_transport", "url": "io.html#property__transport", "type": "property"}, {"access": "", "host": "io", "name": "transport", "url": "io.html#method_transport", "type": "method"}, {"access": "private", "host": "io", "name": "_unshift", "url": "io.html#method__unshift", "type": "method"}, {"access": "private", "host": "io", "name": "_upload", "url": "io.html#method__upload", "type": "method"}, {"access": "private", "host": "io", "name": "_xdr", "url": "io.html#method__xdr", "type": "method"}, {"access": "private", "host": "io", "name": "xdrReady", "url": "io.html#method_xdrReady", "type": "method"}, {"access": "private", "host": "io", "name": "xdrResponse", "url": "io.html#method_xdrResponse", "type": "method"}, {"access": "private", "host": "io", "name": "_xhr", "url": "io.html#method__xhr", "type": "method"}, {"access": "private", "host": "io", "name": "_yQ", "url": "io.html#property__yQ", "type": "property"}];
</script>
</body>
</html>