|
0
|
1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
|
2 |
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
|
|
|
3 |
<head>
|
|
|
4 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
|
|
|
5 |
<title>API: io io (YUI Library)</title>
|
|
|
6 |
|
|
|
7 |
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
|
|
|
8 |
<link rel="stylesheet" type="text/css" href="assets/api.css" />
|
|
|
9 |
|
|
|
10 |
<script type="text/javascript" src="assets/api-js"></script>
|
|
|
11 |
<script type="text/javascript" src="assets/ac-js"></script>
|
|
|
12 |
</head>
|
|
|
13 |
|
|
|
14 |
<body id="yahoo-com">
|
|
|
15 |
|
|
|
16 |
<div id="doc3" class="yui-t2">
|
|
|
17 |
<div id="hd">
|
|
|
18 |
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
|
|
|
19 |
<h3>io <span class="subtitle">3.0.0b1</span></h3>
|
|
|
20 |
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
|
|
|
21 |
> <a href="./module_io.html" title="io">io</a>
|
|
|
22 |
> io
|
|
|
23 |
|
|
|
24 |
<form onsubmit="return false">
|
|
|
25 |
<div id="propertysearch">
|
|
|
26 |
Search: <input autocomplete="off" id="searchinput" />
|
|
|
27 |
<div id="searchresults">
|
|
|
28 |
|
|
|
29 |
</div>
|
|
|
30 |
</div>
|
|
|
31 |
</form>
|
|
|
32 |
</div>
|
|
|
33 |
|
|
|
34 |
<div id="bd">
|
|
|
35 |
<div id="yui-main">
|
|
|
36 |
<div class="yui-b">
|
|
|
37 |
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
|
|
|
38 |
<fieldset>
|
|
|
39 |
<legend>Filters</legend>
|
|
|
40 |
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
|
|
|
41 |
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
|
|
|
42 |
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
|
|
|
43 |
</fieldset>
|
|
|
44 |
</form>
|
|
|
45 |
|
|
|
46 |
<h2>
|
|
|
47 |
|
|
|
48 |
|
|
|
49 |
|
|
|
50 |
|
|
|
51 |
Class <b property="yui:name">io</b>
|
|
|
52 |
<span class="extends">
|
|
|
53 |
</span>
|
|
|
54 |
|
|
|
55 |
</h2>
|
|
|
56 |
<!-- class tree goes here -->
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
<div class="summary description" property="yui:description">
|
|
|
62 |
The io class is a utility that brokers HTTP requests through a simplified
|
|
|
63 |
interface. Specifically, it allows JavaScript to make HTTP requests to
|
|
|
64 |
a resource without a page reload. The underlying transport for making
|
|
|
65 |
same-domain requests is the XMLHttpRequest object. YUI.io can also use
|
|
|
66 |
Flash, if specified as a transport, for cross-domain requests.
|
|
|
67 |
</div>
|
|
|
68 |
|
|
|
69 |
|
|
|
70 |
<div rel="yui:properties" resource="#properties">
|
|
|
71 |
<div class="section field details">
|
|
|
72 |
<h3 id="properties">Properties</h3>
|
|
|
73 |
<div class="content">
|
|
|
74 |
<div class="private" rel="yui:property" resource="#property__e">
|
|
|
75 |
<h4><a name="property__e" property="yui:name">_e</a>
|
|
|
76 |
- <code>private static <span property="yui:type">Object</span></code>
|
|
|
77 |
</h4>
|
|
|
78 |
<div class="detail">
|
|
|
79 |
<div class="description" property="yui:description">
|
|
|
80 |
Reference to "io:complete" event handler.
|
|
|
81 |
</div>
|
|
|
82 |
</div>
|
|
|
83 |
|
|
|
84 |
|
|
|
85 |
|
|
|
86 |
|
|
|
87 |
<hr />
|
|
|
88 |
</div>
|
|
|
89 |
<div class="private" rel="yui:property" resource="#property__fn">
|
|
|
90 |
<h4><a name="property__fn" property="yui:name">_fn</a>
|
|
|
91 |
- <code>private static <span property="yui:type">object</span></code>
|
|
|
92 |
</h4>
|
|
|
93 |
<div class="detail">
|
|
|
94 |
<div class="description" property="yui:description">
|
|
|
95 |
Object that stores callback handlers for cross-domain requests
|
|
|
96 |
when using Flash as the transport.
|
|
|
97 |
</div>
|
|
|
98 |
</div>
|
|
|
99 |
|
|
|
100 |
|
|
|
101 |
|
|
|
102 |
|
|
|
103 |
<hr />
|
|
|
104 |
</div>
|
|
|
105 |
<div class="private" rel="yui:property" resource="#property__headers">
|
|
|
106 |
<h4><a name="property__headers" property="yui:name">_headers</a>
|
|
|
107 |
- <code>private static <span property="yui:type">object</span></code>
|
|
|
108 |
</h4>
|
|
|
109 |
<div class="detail">
|
|
|
110 |
<div class="description" property="yui:description">
|
|
|
111 |
Object of default HTTP headers to be initialized and sent
|
|
|
112 |
for all transactions.
|
|
|
113 |
</div>
|
|
|
114 |
</div>
|
|
|
115 |
|
|
|
116 |
|
|
|
117 |
|
|
|
118 |
|
|
|
119 |
<hr />
|
|
|
120 |
</div>
|
|
|
121 |
<div class="private" rel="yui:property" resource="#property__qState">
|
|
|
122 |
<h4><a name="property__qState" property="yui:name">_qState</a>
|
|
|
123 |
- <code>private static <span property="yui:type">int</span></code>
|
|
|
124 |
</h4>
|
|
|
125 |
<div class="detail">
|
|
|
126 |
<div class="description" property="yui:description">
|
|
|
127 |
Property to determine whether the queue is set to
|
|
|
128 |
1 (active) or 0 (inactive). When inactive, transactions
|
|
|
129 |
will be stored in the queue until the queue is set to active.
|
|
|
130 |
</div>
|
|
|
131 |
</div>
|
|
|
132 |
|
|
|
133 |
|
|
|
134 |
|
|
|
135 |
|
|
|
136 |
<hr />
|
|
|
137 |
</div>
|
|
|
138 |
<div class="private" rel="yui:property" resource="#property__timeOut">
|
|
|
139 |
<h4><a name="property__timeOut" property="yui:name">_timeOut</a>
|
|
|
140 |
- <code>private static <span property="yui:type">object</span></code>
|
|
|
141 |
</h4>
|
|
|
142 |
<div class="detail">
|
|
|
143 |
<div class="description" property="yui:description">
|
|
|
144 |
Object that stores timeout values for any transaction with
|
|
|
145 |
a defined "timeout" configuration property.
|
|
|
146 |
</div>
|
|
|
147 |
</div>
|
|
|
148 |
|
|
|
149 |
|
|
|
150 |
|
|
|
151 |
|
|
|
152 |
<hr />
|
|
|
153 |
</div>
|
|
|
154 |
<div class="private" rel="yui:property" resource="#property__transport">
|
|
|
155 |
<h4><a name="property__transport" property="yui:name">_transport</a>
|
|
|
156 |
- <code>private static <span property="yui:type">object</span></code>
|
|
|
157 |
</h4>
|
|
|
158 |
<div class="detail">
|
|
|
159 |
<div class="description" property="yui:description">
|
|
|
160 |
Map of IO transports.
|
|
|
161 |
</div>
|
|
|
162 |
</div>
|
|
|
163 |
|
|
|
164 |
|
|
|
165 |
|
|
|
166 |
|
|
|
167 |
<hr />
|
|
|
168 |
</div>
|
|
|
169 |
<div class="private" rel="yui:property" resource="#property__yQ">
|
|
|
170 |
<h4><a name="property__yQ" property="yui:name">_yQ</a>
|
|
|
171 |
- <code>private static <span property="yui:type">Object</span></code>
|
|
|
172 |
</h4>
|
|
|
173 |
<div class="detail">
|
|
|
174 |
<div class="description" property="yui:description">
|
|
|
175 |
Array of transactions queued for processing
|
|
|
176 |
</div>
|
|
|
177 |
</div>
|
|
|
178 |
|
|
|
179 |
|
|
|
180 |
|
|
|
181 |
|
|
|
182 |
<hr />
|
|
|
183 |
</div>
|
|
|
184 |
<div class="private" rel="yui:property" resource="#property_transactionId">
|
|
|
185 |
<h4><a name="property_transactionId" property="yui:name">transactionId</a>
|
|
|
186 |
- <code>private static <span property="yui:type">int</span></code>
|
|
|
187 |
</h4>
|
|
|
188 |
<div class="detail">
|
|
|
189 |
<div class="description" property="yui:description">
|
|
|
190 |
A transaction counter that increments for each transaction.
|
|
|
191 |
</div>
|
|
|
192 |
</div>
|
|
|
193 |
|
|
|
194 |
|
|
|
195 |
|
|
|
196 |
|
|
|
197 |
<hr />
|
|
|
198 |
</div>
|
|
|
199 |
</div>
|
|
|
200 |
</div>
|
|
|
201 |
|
|
|
202 |
</div>
|
|
|
203 |
|
|
|
204 |
<div rel="yui:methods" resource="#methods">
|
|
|
205 |
<div class="section method details">
|
|
|
206 |
<h3 id="methods">Methods</h3>
|
|
|
207 |
<div class="content">
|
|
|
208 |
<div class="private" rel="yui:method" resource="#method__async">
|
|
|
209 |
<h4>
|
|
|
210 |
<a name="method__async">_async</a></h4>
|
|
|
211 |
<div class="detail" >
|
|
|
212 |
<code>
|
|
|
213 |
private
|
|
|
214 |
static
|
|
|
215 |
|
|
|
216 |
|
|
|
217 |
<strong property="yui:name">_async</strong>
|
|
|
218 |
(
|
|
|
219 |
|
|
|
220 |
|
|
|
221 |
o
|
|
|
222 |
|
|
|
223 |
|
|
|
224 |
,
|
|
|
225 |
d
|
|
|
226 |
|
|
|
227 |
|
|
|
228 |
,
|
|
|
229 |
c
|
|
|
230 |
|
|
|
231 |
|
|
|
232 |
)
|
|
|
233 |
</code>
|
|
|
234 |
|
|
|
235 |
<div class="description" property="yui:description">
|
|
|
236 |
Method that sends the transaction request.
|
|
|
237 |
</div>
|
|
|
238 |
|
|
|
239 |
<div class="description">
|
|
|
240 |
|
|
|
241 |
<dl rel="yui:parameters">
|
|
|
242 |
<dt>Parameters:</dt>
|
|
|
243 |
<dd rel="yui:parameter">
|
|
|
244 |
<code><span property="yui:name">o</span>
|
|
|
245 |
<<span property="yui:type">object</span>>
|
|
|
246 |
</code>
|
|
|
247 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
248 |
</dd>
|
|
|
249 |
<dd rel="yui:parameter">
|
|
|
250 |
<code><span property="yui:name">d</span>
|
|
|
251 |
<<span property="yui:type">string</span>>
|
|
|
252 |
</code>
|
|
|
253 |
<span property="yui:description"> - Transaction data.</span>
|
|
|
254 |
</dd>
|
|
|
255 |
<dd rel="yui:parameter">
|
|
|
256 |
<code><span property="yui:name">c</span>
|
|
|
257 |
<<span property="yui:type">object</span>>
|
|
|
258 |
</code>
|
|
|
259 |
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
|
|
|
260 |
</dd>
|
|
|
261 |
</dl>
|
|
|
262 |
|
|
|
263 |
|
|
|
264 |
|
|
|
265 |
|
|
|
266 |
|
|
|
267 |
</div>
|
|
|
268 |
|
|
|
269 |
</div>
|
|
|
270 |
<hr />
|
|
|
271 |
</div>
|
|
|
272 |
<div class="private" rel="yui:method" resource="#method__clearTimeout">
|
|
|
273 |
<h4>
|
|
|
274 |
<a name="method__clearTimeout">_clearTimeout</a></h4>
|
|
|
275 |
<div class="detail" >
|
|
|
276 |
<code>
|
|
|
277 |
private
|
|
|
278 |
static
|
|
|
279 |
|
|
|
280 |
|
|
|
281 |
<strong property="yui:name">_clearTimeout</strong>
|
|
|
282 |
(
|
|
|
283 |
|
|
|
284 |
|
|
|
285 |
id
|
|
|
286 |
|
|
|
287 |
|
|
|
288 |
)
|
|
|
289 |
</code>
|
|
|
290 |
|
|
|
291 |
<div class="description" property="yui:description">
|
|
|
292 |
Clears the timeout interval started by _startTimeout().
|
|
|
293 |
</div>
|
|
|
294 |
|
|
|
295 |
<div class="description">
|
|
|
296 |
|
|
|
297 |
<dl rel="yui:parameters">
|
|
|
298 |
<dt>Parameters:</dt>
|
|
|
299 |
<dd rel="yui:parameter">
|
|
|
300 |
<code><span property="yui:name">id</span>
|
|
|
301 |
<<span property="yui:type">number</span>>
|
|
|
302 |
</code>
|
|
|
303 |
<span property="yui:description"> - Transaction id.</span>
|
|
|
304 |
</dd>
|
|
|
305 |
</dl>
|
|
|
306 |
|
|
|
307 |
|
|
|
308 |
|
|
|
309 |
|
|
|
310 |
|
|
|
311 |
</div>
|
|
|
312 |
|
|
|
313 |
</div>
|
|
|
314 |
<hr />
|
|
|
315 |
</div>
|
|
|
316 |
<div class="private" rel="yui:method" resource="#method__concat">
|
|
|
317 |
<h4>
|
|
|
318 |
<a name="method__concat">_concat</a></h4>
|
|
|
319 |
<div class="detail" >
|
|
|
320 |
<code>
|
|
|
321 |
private
|
|
|
322 |
static
|
|
|
323 |
|
|
|
324 |
|
|
|
325 |
<strong property="yui:name">_concat</strong>
|
|
|
326 |
(
|
|
|
327 |
|
|
|
328 |
|
|
|
329 |
s
|
|
|
330 |
|
|
|
331 |
|
|
|
332 |
,
|
|
|
333 |
d
|
|
|
334 |
|
|
|
335 |
|
|
|
336 |
)
|
|
|
337 |
</code>
|
|
|
338 |
|
|
|
339 |
<div class="description" property="yui:description">
|
|
|
340 |
Method that concatenates string data for HTTP GET transactions.
|
|
|
341 |
</div>
|
|
|
342 |
|
|
|
343 |
<div class="description">
|
|
|
344 |
|
|
|
345 |
<dl rel="yui:parameters">
|
|
|
346 |
<dt>Parameters:</dt>
|
|
|
347 |
<dd rel="yui:parameter">
|
|
|
348 |
<code><span property="yui:name">s</span>
|
|
|
349 |
<<span property="yui:type">string</span>>
|
|
|
350 |
</code>
|
|
|
351 |
<span property="yui:description"> - URI or root data.</span>
|
|
|
352 |
</dd>
|
|
|
353 |
<dd rel="yui:parameter">
|
|
|
354 |
<code><span property="yui:name">d</span>
|
|
|
355 |
<<span property="yui:type">string</span>>
|
|
|
356 |
</code>
|
|
|
357 |
<span property="yui:description"> - data to be concatenated onto URI.</span>
|
|
|
358 |
</dd>
|
|
|
359 |
</dl>
|
|
|
360 |
|
|
|
361 |
|
|
|
362 |
|
|
|
363 |
|
|
|
364 |
|
|
|
365 |
</div>
|
|
|
366 |
|
|
|
367 |
</div>
|
|
|
368 |
<hr />
|
|
|
369 |
</div>
|
|
|
370 |
<div class="private" rel="yui:method" resource="#method__create">
|
|
|
371 |
<h4>
|
|
|
372 |
<a name="method__create">_create</a></h4>
|
|
|
373 |
<div class="detail" >
|
|
|
374 |
<code>
|
|
|
375 |
private
|
|
|
376 |
static
|
|
|
377 |
|
|
|
378 |
|
|
|
379 |
<strong property="yui:name">_create</strong>
|
|
|
380 |
(
|
|
|
381 |
|
|
|
382 |
|
|
|
383 |
s
|
|
|
384 |
|
|
|
385 |
|
|
|
386 |
,
|
|
|
387 |
c
|
|
|
388 |
|
|
|
389 |
|
|
|
390 |
)
|
|
|
391 |
</code>
|
|
|
392 |
|
|
|
393 |
<div class="description" property="yui:description">
|
|
|
394 |
Method that creates a unique transaction object for each
|
|
|
395 |
request.
|
|
|
396 |
</div>
|
|
|
397 |
|
|
|
398 |
<div class="description">
|
|
|
399 |
|
|
|
400 |
<dl rel="yui:parameters">
|
|
|
401 |
<dt>Parameters:</dt>
|
|
|
402 |
<dd rel="yui:parameter">
|
|
|
403 |
<code><span property="yui:name">s</span>
|
|
|
404 |
<<span property="yui:type">number</span>>
|
|
|
405 |
</code>
|
|
|
406 |
<span property="yui:description"> - URI or root data.</span>
|
|
|
407 |
</dd>
|
|
|
408 |
<dd rel="yui:parameter">
|
|
|
409 |
<code><span property="yui:name">c</span>
|
|
|
410 |
<<span property="yui:type">number</span>>
|
|
|
411 |
</code>
|
|
|
412 |
<span property="yui:description"> - configuration object</span>
|
|
|
413 |
</dd>
|
|
|
414 |
</dl>
|
|
|
415 |
|
|
|
416 |
|
|
|
417 |
|
|
|
418 |
|
|
|
419 |
|
|
|
420 |
</div>
|
|
|
421 |
|
|
|
422 |
</div>
|
|
|
423 |
<hr />
|
|
|
424 |
</div>
|
|
|
425 |
<div class="private" rel="yui:method" resource="#method__handleResponse">
|
|
|
426 |
<h4>
|
|
|
427 |
<a name="method__handleResponse">_handleResponse</a></h4>
|
|
|
428 |
<div class="detail" >
|
|
|
429 |
<code>
|
|
|
430 |
private
|
|
|
431 |
static
|
|
|
432 |
|
|
|
433 |
|
|
|
434 |
<strong property="yui:name">_handleResponse</strong>
|
|
|
435 |
(
|
|
|
436 |
|
|
|
437 |
|
|
|
438 |
o
|
|
|
439 |
|
|
|
440 |
|
|
|
441 |
,
|
|
|
442 |
c
|
|
|
443 |
|
|
|
444 |
|
|
|
445 |
)
|
|
|
446 |
</code>
|
|
|
447 |
|
|
|
448 |
<div class="description" property="yui:description">
|
|
|
449 |
Method that determines if a transaction response qualifies
|
|
|
450 |
as success or failure, based on the response HTTP status code, and
|
|
|
451 |
fires the appropriate success or failure events.
|
|
|
452 |
</div>
|
|
|
453 |
|
|
|
454 |
<div class="description">
|
|
|
455 |
|
|
|
456 |
<dl rel="yui:parameters">
|
|
|
457 |
<dt>Parameters:</dt>
|
|
|
458 |
<dd rel="yui:parameter">
|
|
|
459 |
<code><span property="yui:name">o</span>
|
|
|
460 |
<<span property="yui:type">object</span>>
|
|
|
461 |
</code>
|
|
|
462 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
463 |
</dd>
|
|
|
464 |
<dd rel="yui:parameter">
|
|
|
465 |
<code><span property="yui:name">c</span>
|
|
|
466 |
<<span property="yui:type">object</span>>
|
|
|
467 |
</code>
|
|
|
468 |
<span property="yui:description"> - Configuration object passed to io().</span>
|
|
|
469 |
</dd>
|
|
|
470 |
</dl>
|
|
|
471 |
|
|
|
472 |
|
|
|
473 |
|
|
|
474 |
|
|
|
475 |
|
|
|
476 |
</div>
|
|
|
477 |
|
|
|
478 |
</div>
|
|
|
479 |
<hr />
|
|
|
480 |
</div>
|
|
|
481 |
<div class="private" rel="yui:method" resource="#method__id">
|
|
|
482 |
<h4>
|
|
|
483 |
<a name="method__id">_id</a></h4>
|
|
|
484 |
<div class="detail" >
|
|
|
485 |
<code>
|
|
|
486 |
private
|
|
|
487 |
static
|
|
|
488 |
|
|
|
489 |
|
|
|
490 |
<strong property="yui:name">_id</strong>
|
|
|
491 |
(
|
|
|
492 |
)
|
|
|
493 |
</code>
|
|
|
494 |
|
|
|
495 |
<div class="description" property="yui:description">
|
|
|
496 |
Method that increments _transactionId for each transaction.
|
|
|
497 |
</div>
|
|
|
498 |
|
|
|
499 |
<div class="description">
|
|
|
500 |
|
|
|
501 |
|
|
|
502 |
|
|
|
503 |
|
|
|
504 |
|
|
|
505 |
|
|
|
506 |
</div>
|
|
|
507 |
|
|
|
508 |
</div>
|
|
|
509 |
<hr />
|
|
|
510 |
</div>
|
|
|
511 |
<div class="private" rel="yui:method" resource="#method__io">
|
|
|
512 |
<h4>
|
|
|
513 |
<a name="method__io">_io</a></h4>
|
|
|
514 |
<div class="detail" >
|
|
|
515 |
<code>
|
|
|
516 |
private
|
|
|
517 |
static
|
|
|
518 |
|
|
|
519 |
|
|
|
520 |
<strong property="yui:name">_io</strong>
|
|
|
521 |
(
|
|
|
522 |
|
|
|
523 |
|
|
|
524 |
uri
|
|
|
525 |
|
|
|
526 |
|
|
|
527 |
,
|
|
|
528 |
c
|
|
|
529 |
|
|
|
530 |
|
|
|
531 |
)
|
|
|
532 |
</code>
|
|
|
533 |
|
|
|
534 |
<div class="description" property="yui:description">
|
|
|
535 |
Method for requesting a transaction. _io() is implemented as
|
|
|
536 |
yui.io(). Each transaction may include a configuration object. Its
|
|
|
537 |
properties are:
|
|
|
538 |
method: HTTP method verb (e.g., GET or POST). If this property is not
|
|
|
539 |
not defined, the default value will be GET.
|
|
|
540 |
data: This is the name-value string that will be sent as the transaction
|
|
|
541 |
data. If the request is HTTP GET, the data become part of
|
|
|
542 |
querystring. If HTTP POST, the data are sent in the message body.
|
|
|
543 |
xdr: Defines the transport to be used for cross-domain requests. By
|
|
|
544 |
setting this property, the transaction will use the specified
|
|
|
545 |
transport instead of XMLHttpRequest. Currently, the only alternate
|
|
|
546 |
transport supported is Flash (e.g., { xdr: 'flash' }).
|
|
|
547 |
form: This is a defined object used to process HTML form as data. The
|
|
|
548 |
properties are:
|
|
|
549 |
{
|
|
|
550 |
id: object, //HTML form object or id of HTML form
|
|
|
551 |
useDisabled: boolean, //Allow disabled HTML form field values
|
|
|
552 |
to be sent as part of the data.
|
|
|
553 |
}
|
|
|
554 |
on: This is a defined object used to create and handle specific
|
|
|
555 |
events during a transaction lifecycle. These events will fire in
|
|
|
556 |
addition to the global io events. The events are:
|
|
|
557 |
start - This event is fired when a request is sent to a resource.
|
|
|
558 |
complete - This event fires when the transaction is complete.
|
|
|
559 |
success - This event fires when the response status resolves to
|
|
|
560 |
HTTP 2xx.
|
|
|
561 |
failure - This event fires when the response status resolves to
|
|
|
562 |
HTTP 4xx, 5xx; and, for all transaction exceptions,
|
|
|
563 |
including aborted transactions and transaction timeouts.
|
|
|
564 |
end - This even is fired at the conclusion of the transaction
|
|
|
565 |
lifecycle, after a success or failure resolution.
|
|
|
566 |
The properties are:
|
|
|
567 |
{
|
|
|
568 |
start: function(id, args){},
|
|
|
569 |
complete: function(id, responseobject, args){},
|
|
|
570 |
success: function(id, responseobject, args){},
|
|
|
571 |
failure: function(id, responseobject, args){},
|
|
|
572 |
end: function(id, args){}
|
|
|
573 |
}
|
|
|
574 |
Each property can reference a function or be written as an
|
|
|
575 |
inline function.
|
|
|
576 |
context: Object reference for an event handler when it is implemented
|
|
|
577 |
as a method of a base object. Defining "context" will preserve
|
|
|
578 |
the proper reference of "this" used in the event handler.
|
|
|
579 |
headers: This is a defined object of client headers, as many as.
|
|
|
580 |
desired for the transaction. These headers are sentThe object
|
|
|
581 |
pattern is:
|
|
|
582 |
{
|
|
|
583 |
header: value
|
|
|
584 |
}
|
|
|
585 |
timeout: This value, defined as milliseconds, is a time threshold for the
|
|
|
586 |
transaction. When this threshold is reached, and the transaction's
|
|
|
587 |
Complete event has not yet fired, the transaction will be aborted.
|
|
|
588 |
arguments: Object, array, string, or number passed to all registered
|
|
|
589 |
event handlers. This value is available as the second
|
|
|
590 |
argument in the "start" and "abort" event handlers; and, it is
|
|
|
591 |
the third argument in the "complete", "success", and "failure"
|
|
|
592 |
event handlers.
|
|
|
593 |
</div>
|
|
|
594 |
|
|
|
595 |
<div class="description">
|
|
|
596 |
|
|
|
597 |
<dl rel="yui:parameters">
|
|
|
598 |
<dt>Parameters:</dt>
|
|
|
599 |
<dd rel="yui:parameter">
|
|
|
600 |
<code><span property="yui:name">uri</span>
|
|
|
601 |
<<span property="yui:type">string</span>>
|
|
|
602 |
</code>
|
|
|
603 |
<span property="yui:description"> - qualified path to transaction resource.</span>
|
|
|
604 |
</dd>
|
|
|
605 |
<dd rel="yui:parameter">
|
|
|
606 |
<code><span property="yui:name">c</span>
|
|
|
607 |
<<span property="yui:type">object</span>>
|
|
|
608 |
</code>
|
|
|
609 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
610 |
</dd>
|
|
|
611 |
</dl>
|
|
|
612 |
|
|
|
613 |
|
|
|
614 |
|
|
|
615 |
|
|
|
616 |
|
|
|
617 |
</div>
|
|
|
618 |
|
|
|
619 |
</div>
|
|
|
620 |
<hr />
|
|
|
621 |
</div>
|
|
|
622 |
<div class="private" rel="yui:method" resource="#method__ioCancel">
|
|
|
623 |
<h4>
|
|
|
624 |
<a name="method__ioCancel">_ioCancel</a></h4>
|
|
|
625 |
<div class="detail" >
|
|
|
626 |
<code>
|
|
|
627 |
private
|
|
|
628 |
static
|
|
|
629 |
|
|
|
630 |
|
|
|
631 |
<strong property="yui:name">_ioCancel</strong>
|
|
|
632 |
(
|
|
|
633 |
|
|
|
634 |
|
|
|
635 |
o
|
|
|
636 |
|
|
|
637 |
|
|
|
638 |
,
|
|
|
639 |
c
|
|
|
640 |
|
|
|
641 |
|
|
|
642 |
,
|
|
|
643 |
s
|
|
|
644 |
|
|
|
645 |
|
|
|
646 |
)
|
|
|
647 |
</code>
|
|
|
648 |
|
|
|
649 |
<div class="description" property="yui:description">
|
|
|
650 |
Terminates a transaction due to an explicit abort or
|
|
|
651 |
timeout.
|
|
|
652 |
</div>
|
|
|
653 |
|
|
|
654 |
<div class="description">
|
|
|
655 |
|
|
|
656 |
<dl rel="yui:parameters">
|
|
|
657 |
<dt>Parameters:</dt>
|
|
|
658 |
<dd rel="yui:parameter">
|
|
|
659 |
<code><span property="yui:name">o</span>
|
|
|
660 |
<<span property="yui:type">object</span>>
|
|
|
661 |
</code>
|
|
|
662 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
663 |
</dd>
|
|
|
664 |
<dd rel="yui:parameter">
|
|
|
665 |
<code><span property="yui:name">c</span>
|
|
|
666 |
<<span property="yui:type">object</span>>
|
|
|
667 |
</code>
|
|
|
668 |
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
|
|
|
669 |
</dd>
|
|
|
670 |
<dd rel="yui:parameter">
|
|
|
671 |
<code><span property="yui:name">s</span>
|
|
|
672 |
<<span property="yui:type">string</span>>
|
|
|
673 |
</code>
|
|
|
674 |
<span property="yui:description"> - Identifies timed out or aborted transaction.</span>
|
|
|
675 |
</dd>
|
|
|
676 |
</dl>
|
|
|
677 |
|
|
|
678 |
|
|
|
679 |
|
|
|
680 |
|
|
|
681 |
|
|
|
682 |
</div>
|
|
|
683 |
|
|
|
684 |
</div>
|
|
|
685 |
<hr />
|
|
|
686 |
</div>
|
|
|
687 |
<div class="private" rel="yui:method" resource="#method__ioComplete">
|
|
|
688 |
<h4>
|
|
|
689 |
<a name="method__ioComplete">_ioComplete</a></h4>
|
|
|
690 |
<div class="detail" >
|
|
|
691 |
<code>
|
|
|
692 |
private
|
|
|
693 |
static
|
|
|
694 |
|
|
|
695 |
|
|
|
696 |
<strong property="yui:name">_ioComplete</strong>
|
|
|
697 |
(
|
|
|
698 |
|
|
|
699 |
|
|
|
700 |
o
|
|
|
701 |
|
|
|
702 |
|
|
|
703 |
,
|
|
|
704 |
c
|
|
|
705 |
|
|
|
706 |
|
|
|
707 |
)
|
|
|
708 |
</code>
|
|
|
709 |
|
|
|
710 |
<div class="description" property="yui:description">
|
|
|
711 |
Fires event "io:complete" and creates, fires a
|
|
|
712 |
transaction-specific "complete" event, if config.on.complete is
|
|
|
713 |
defined.
|
|
|
714 |
</div>
|
|
|
715 |
|
|
|
716 |
<div class="description">
|
|
|
717 |
|
|
|
718 |
<dl rel="yui:parameters">
|
|
|
719 |
<dt>Parameters:</dt>
|
|
|
720 |
<dd rel="yui:parameter">
|
|
|
721 |
<code><span property="yui:name">o</span>
|
|
|
722 |
<<span property="yui:type">object</span>>
|
|
|
723 |
</code>
|
|
|
724 |
<span property="yui:description"> - transaction object.</span>
|
|
|
725 |
</dd>
|
|
|
726 |
<dd rel="yui:parameter">
|
|
|
727 |
<code><span property="yui:name">c</span>
|
|
|
728 |
<<span property="yui:type">object</span>>
|
|
|
729 |
</code>
|
|
|
730 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
731 |
</dd>
|
|
|
732 |
</dl>
|
|
|
733 |
|
|
|
734 |
|
|
|
735 |
|
|
|
736 |
|
|
|
737 |
|
|
|
738 |
</div>
|
|
|
739 |
|
|
|
740 |
</div>
|
|
|
741 |
<hr />
|
|
|
742 |
</div>
|
|
|
743 |
<div class="private" rel="yui:method" resource="#method__ioEnd">
|
|
|
744 |
<h4>
|
|
|
745 |
<a name="method__ioEnd">_ioEnd</a></h4>
|
|
|
746 |
<div class="detail" >
|
|
|
747 |
<code>
|
|
|
748 |
private
|
|
|
749 |
static
|
|
|
750 |
|
|
|
751 |
|
|
|
752 |
<strong property="yui:name">_ioEnd</strong>
|
|
|
753 |
(
|
|
|
754 |
|
|
|
755 |
|
|
|
756 |
o
|
|
|
757 |
|
|
|
758 |
|
|
|
759 |
,
|
|
|
760 |
c
|
|
|
761 |
|
|
|
762 |
|
|
|
763 |
)
|
|
|
764 |
</code>
|
|
|
765 |
|
|
|
766 |
<div class="description" property="yui:description">
|
|
|
767 |
Fires event "io:end" and creates, fires a
|
|
|
768 |
transaction-specific "end" event, if config.on.end is
|
|
|
769 |
defined.
|
|
|
770 |
</div>
|
|
|
771 |
|
|
|
772 |
<div class="description">
|
|
|
773 |
|
|
|
774 |
<dl rel="yui:parameters">
|
|
|
775 |
<dt>Parameters:</dt>
|
|
|
776 |
<dd rel="yui:parameter">
|
|
|
777 |
<code><span property="yui:name">o</span>
|
|
|
778 |
<<span property="yui:type">object</span>>
|
|
|
779 |
</code>
|
|
|
780 |
<span property="yui:description"> - transaction object.</span>
|
|
|
781 |
</dd>
|
|
|
782 |
<dd rel="yui:parameter">
|
|
|
783 |
<code><span property="yui:name">c</span>
|
|
|
784 |
<<span property="yui:type">object</span>>
|
|
|
785 |
</code>
|
|
|
786 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
787 |
</dd>
|
|
|
788 |
</dl>
|
|
|
789 |
|
|
|
790 |
|
|
|
791 |
|
|
|
792 |
|
|
|
793 |
|
|
|
794 |
</div>
|
|
|
795 |
|
|
|
796 |
</div>
|
|
|
797 |
<hr />
|
|
|
798 |
</div>
|
|
|
799 |
<div class="private" rel="yui:method" resource="#method__ioFailure">
|
|
|
800 |
<h4>
|
|
|
801 |
<a name="method__ioFailure">_ioFailure</a></h4>
|
|
|
802 |
<div class="detail" >
|
|
|
803 |
<code>
|
|
|
804 |
private
|
|
|
805 |
static
|
|
|
806 |
|
|
|
807 |
|
|
|
808 |
<strong property="yui:name">_ioFailure</strong>
|
|
|
809 |
(
|
|
|
810 |
|
|
|
811 |
|
|
|
812 |
o
|
|
|
813 |
|
|
|
814 |
|
|
|
815 |
,
|
|
|
816 |
c
|
|
|
817 |
|
|
|
818 |
|
|
|
819 |
)
|
|
|
820 |
</code>
|
|
|
821 |
|
|
|
822 |
<div class="description" property="yui:description">
|
|
|
823 |
Fires event "io:failure" and creates, fires a
|
|
|
824 |
transaction-specific "failure" event, if config.on.failure is
|
|
|
825 |
defined.
|
|
|
826 |
</div>
|
|
|
827 |
|
|
|
828 |
<div class="description">
|
|
|
829 |
|
|
|
830 |
<dl rel="yui:parameters">
|
|
|
831 |
<dt>Parameters:</dt>
|
|
|
832 |
<dd rel="yui:parameter">
|
|
|
833 |
<code><span property="yui:name">o</span>
|
|
|
834 |
<<span property="yui:type">object</span>>
|
|
|
835 |
</code>
|
|
|
836 |
<span property="yui:description"> - transaction object.</span>
|
|
|
837 |
</dd>
|
|
|
838 |
<dd rel="yui:parameter">
|
|
|
839 |
<code><span property="yui:name">c</span>
|
|
|
840 |
<<span property="yui:type">object</span>>
|
|
|
841 |
</code>
|
|
|
842 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
843 |
</dd>
|
|
|
844 |
</dl>
|
|
|
845 |
|
|
|
846 |
|
|
|
847 |
|
|
|
848 |
|
|
|
849 |
|
|
|
850 |
</div>
|
|
|
851 |
|
|
|
852 |
</div>
|
|
|
853 |
<hr />
|
|
|
854 |
</div>
|
|
|
855 |
<div class="private" rel="yui:method" resource="#method__ioStart">
|
|
|
856 |
<h4>
|
|
|
857 |
<a name="method__ioStart">_ioStart</a></h4>
|
|
|
858 |
<div class="detail" >
|
|
|
859 |
<code>
|
|
|
860 |
private
|
|
|
861 |
static
|
|
|
862 |
|
|
|
863 |
|
|
|
864 |
<strong property="yui:name">_ioStart</strong>
|
|
|
865 |
(
|
|
|
866 |
|
|
|
867 |
|
|
|
868 |
id
|
|
|
869 |
|
|
|
870 |
|
|
|
871 |
,
|
|
|
872 |
c
|
|
|
873 |
|
|
|
874 |
|
|
|
875 |
)
|
|
|
876 |
</code>
|
|
|
877 |
|
|
|
878 |
<div class="description" property="yui:description">
|
|
|
879 |
Fires event "io:start" and creates, fires a
|
|
|
880 |
transaction-specific start event, if config.on.start is
|
|
|
881 |
defined.
|
|
|
882 |
</div>
|
|
|
883 |
|
|
|
884 |
<div class="description">
|
|
|
885 |
|
|
|
886 |
<dl rel="yui:parameters">
|
|
|
887 |
<dt>Parameters:</dt>
|
|
|
888 |
<dd rel="yui:parameter">
|
|
|
889 |
<code><span property="yui:name">id</span>
|
|
|
890 |
<<span property="yui:type">number</span>>
|
|
|
891 |
</code>
|
|
|
892 |
<span property="yui:description"> - transaction id</span>
|
|
|
893 |
</dd>
|
|
|
894 |
<dd rel="yui:parameter">
|
|
|
895 |
<code><span property="yui:name">c</span>
|
|
|
896 |
<<span property="yui:type">object</span>>
|
|
|
897 |
</code>
|
|
|
898 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
899 |
</dd>
|
|
|
900 |
</dl>
|
|
|
901 |
|
|
|
902 |
|
|
|
903 |
|
|
|
904 |
|
|
|
905 |
|
|
|
906 |
</div>
|
|
|
907 |
|
|
|
908 |
</div>
|
|
|
909 |
<hr />
|
|
|
910 |
</div>
|
|
|
911 |
<div class="private" rel="yui:method" resource="#method__ioSuccess">
|
|
|
912 |
<h4>
|
|
|
913 |
<a name="method__ioSuccess">_ioSuccess</a></h4>
|
|
|
914 |
<div class="detail" >
|
|
|
915 |
<code>
|
|
|
916 |
private
|
|
|
917 |
static
|
|
|
918 |
|
|
|
919 |
|
|
|
920 |
<strong property="yui:name">_ioSuccess</strong>
|
|
|
921 |
(
|
|
|
922 |
|
|
|
923 |
|
|
|
924 |
o
|
|
|
925 |
|
|
|
926 |
|
|
|
927 |
,
|
|
|
928 |
c
|
|
|
929 |
|
|
|
930 |
|
|
|
931 |
)
|
|
|
932 |
</code>
|
|
|
933 |
|
|
|
934 |
<div class="description" property="yui:description">
|
|
|
935 |
Fires event "io:success" and creates, fires a
|
|
|
936 |
transaction-specific "success" event, if config.on.success is
|
|
|
937 |
defined.
|
|
|
938 |
</div>
|
|
|
939 |
|
|
|
940 |
<div class="description">
|
|
|
941 |
|
|
|
942 |
<dl rel="yui:parameters">
|
|
|
943 |
<dt>Parameters:</dt>
|
|
|
944 |
<dd rel="yui:parameter">
|
|
|
945 |
<code><span property="yui:name">o</span>
|
|
|
946 |
<<span property="yui:type">object</span>>
|
|
|
947 |
</code>
|
|
|
948 |
<span property="yui:description"> - transaction object.</span>
|
|
|
949 |
</dd>
|
|
|
950 |
<dd rel="yui:parameter">
|
|
|
951 |
<code><span property="yui:name">c</span>
|
|
|
952 |
<<span property="yui:type">object</span>>
|
|
|
953 |
</code>
|
|
|
954 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
955 |
</dd>
|
|
|
956 |
</dl>
|
|
|
957 |
|
|
|
958 |
|
|
|
959 |
|
|
|
960 |
|
|
|
961 |
|
|
|
962 |
</div>
|
|
|
963 |
|
|
|
964 |
</div>
|
|
|
965 |
<hr />
|
|
|
966 |
</div>
|
|
|
967 |
<div class="private" rel="yui:method" resource="#method__isInProgress">
|
|
|
968 |
<h4>
|
|
|
969 |
<a name="method__isInProgress">_isInProgress</a></h4>
|
|
|
970 |
<div class="detail" >
|
|
|
971 |
<code>
|
|
|
972 |
private
|
|
|
973 |
static
|
|
|
974 |
|
|
|
975 |
|
|
|
976 |
<strong property="yui:name">_isInProgress</strong>
|
|
|
977 |
(
|
|
|
978 |
|
|
|
979 |
|
|
|
980 |
o
|
|
|
981 |
|
|
|
982 |
|
|
|
983 |
)
|
|
|
984 |
</code>
|
|
|
985 |
|
|
|
986 |
<div class="description" property="yui:description">
|
|
|
987 |
Determines if a cross-domain transaction is still
|
|
|
988 |
in progress.
|
|
|
989 |
</div>
|
|
|
990 |
|
|
|
991 |
<div class="description">
|
|
|
992 |
|
|
|
993 |
<dl rel="yui:parameters">
|
|
|
994 |
<dt>Parameters:</dt>
|
|
|
995 |
<dd rel="yui:parameter">
|
|
|
996 |
<code><span property="yui:name">o</span>
|
|
|
997 |
<<span property="yui:type">object</span>>
|
|
|
998 |
</code>
|
|
|
999 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
1000 |
</dd>
|
|
|
1001 |
</dl>
|
|
|
1002 |
|
|
|
1003 |
|
|
|
1004 |
|
|
|
1005 |
|
|
|
1006 |
|
|
|
1007 |
</div>
|
|
|
1008 |
|
|
|
1009 |
</div>
|
|
|
1010 |
<hr />
|
|
|
1011 |
</div>
|
|
|
1012 |
<div class="private" rel="yui:method" resource="#method__queue">
|
|
|
1013 |
<h4>
|
|
|
1014 |
<a name="method__queue">_queue</a></h4>
|
|
|
1015 |
<div class="detail" >
|
|
|
1016 |
<code>
|
|
|
1017 |
private
|
|
|
1018 |
static
|
|
|
1019 |
|
|
|
1020 |
|
|
|
1021 |
<strong property="yui:name">_queue</strong>
|
|
|
1022 |
(
|
|
|
1023 |
)
|
|
|
1024 |
</code>
|
|
|
1025 |
|
|
|
1026 |
<div class="description" property="yui:description">
|
|
|
1027 |
Method for requesting a transaction, and queueing the
|
|
|
1028 |
request before it is sent to the resource.
|
|
|
1029 |
</div>
|
|
|
1030 |
|
|
|
1031 |
<div class="description">
|
|
|
1032 |
|
|
|
1033 |
|
|
|
1034 |
|
|
|
1035 |
|
|
|
1036 |
|
|
|
1037 |
|
|
|
1038 |
</div>
|
|
|
1039 |
|
|
|
1040 |
</div>
|
|
|
1041 |
<hr />
|
|
|
1042 |
</div>
|
|
|
1043 |
<div class="private" rel="yui:method" resource="#method__readyState">
|
|
|
1044 |
<h4>
|
|
|
1045 |
<a name="method__readyState">_readyState</a></h4>
|
|
|
1046 |
<div class="detail" >
|
|
|
1047 |
<code>
|
|
|
1048 |
private
|
|
|
1049 |
static
|
|
|
1050 |
|
|
|
1051 |
|
|
|
1052 |
<strong property="yui:name">_readyState</strong>
|
|
|
1053 |
(
|
|
|
1054 |
|
|
|
1055 |
|
|
|
1056 |
o
|
|
|
1057 |
|
|
|
1058 |
|
|
|
1059 |
,
|
|
|
1060 |
c
|
|
|
1061 |
|
|
|
1062 |
|
|
|
1063 |
)
|
|
|
1064 |
</code>
|
|
|
1065 |
|
|
|
1066 |
<div class="description" property="yui:description">
|
|
|
1067 |
Event handler bound to onreadystatechange.
|
|
|
1068 |
</div>
|
|
|
1069 |
|
|
|
1070 |
<div class="description">
|
|
|
1071 |
|
|
|
1072 |
<dl rel="yui:parameters">
|
|
|
1073 |
<dt>Parameters:</dt>
|
|
|
1074 |
<dd rel="yui:parameter">
|
|
|
1075 |
<code><span property="yui:name">o</span>
|
|
|
1076 |
<<span property="yui:type">object</span>>
|
|
|
1077 |
</code>
|
|
|
1078 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
1079 |
</dd>
|
|
|
1080 |
<dd rel="yui:parameter">
|
|
|
1081 |
<code><span property="yui:name">c</span>
|
|
|
1082 |
<<span property="yui:type">object</span>>
|
|
|
1083 |
</code>
|
|
|
1084 |
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
|
|
|
1085 |
</dd>
|
|
|
1086 |
</dl>
|
|
|
1087 |
|
|
|
1088 |
|
|
|
1089 |
|
|
|
1090 |
|
|
|
1091 |
|
|
|
1092 |
</div>
|
|
|
1093 |
|
|
|
1094 |
</div>
|
|
|
1095 |
<hr />
|
|
|
1096 |
</div>
|
|
|
1097 |
<div class="private" rel="yui:method" resource="#method__remove">
|
|
|
1098 |
<h4>
|
|
|
1099 |
<a name="method__remove">_remove</a></h4>
|
|
|
1100 |
<div class="detail" >
|
|
|
1101 |
<code>
|
|
|
1102 |
private
|
|
|
1103 |
static
|
|
|
1104 |
|
|
|
1105 |
|
|
|
1106 |
<strong property="yui:name">_remove</strong>
|
|
|
1107 |
(
|
|
|
1108 |
)
|
|
|
1109 |
</code>
|
|
|
1110 |
|
|
|
1111 |
<div class="description" property="yui:description">
|
|
|
1112 |
Method for removing a specific, pending transaction from
|
|
|
1113 |
the queue.
|
|
|
1114 |
</div>
|
|
|
1115 |
|
|
|
1116 |
<div class="description">
|
|
|
1117 |
|
|
|
1118 |
|
|
|
1119 |
|
|
|
1120 |
|
|
|
1121 |
|
|
|
1122 |
|
|
|
1123 |
</div>
|
|
|
1124 |
|
|
|
1125 |
</div>
|
|
|
1126 |
<hr />
|
|
|
1127 |
</div>
|
|
|
1128 |
<div class="private" rel="yui:method" resource="#method__serialize">
|
|
|
1129 |
<h4>
|
|
|
1130 |
<a name="method__serialize">_serialize</a></h4>
|
|
|
1131 |
<div class="detail" >
|
|
|
1132 |
<code>
|
|
|
1133 |
private
|
|
|
1134 |
static
|
|
|
1135 |
|
|
|
1136 |
|
|
|
1137 |
<strong property="yui:name">_serialize</strong>
|
|
|
1138 |
(
|
|
|
1139 |
|
|
|
1140 |
|
|
|
1141 |
o
|
|
|
1142 |
|
|
|
1143 |
|
|
|
1144 |
)
|
|
|
1145 |
</code>
|
|
|
1146 |
|
|
|
1147 |
<div class="description" property="yui:description">
|
|
|
1148 |
Method to enumerate through an HTML form's elements collection
|
|
|
1149 |
and return a string comprised of key-value pairs.
|
|
|
1150 |
</div>
|
|
|
1151 |
|
|
|
1152 |
<div class="description">
|
|
|
1153 |
|
|
|
1154 |
<dl rel="yui:parameters">
|
|
|
1155 |
<dt>Parameters:</dt>
|
|
|
1156 |
<dd rel="yui:parameter">
|
|
|
1157 |
<code><span property="yui:name">o</span>
|
|
|
1158 |
<<span property="yui:type">object</span>>
|
|
|
1159 |
</code>
|
|
|
1160 |
<span property="yui:description"> - YUI form node or HTML form id.</span>
|
|
|
1161 |
</dd>
|
|
|
1162 |
</dl>
|
|
|
1163 |
|
|
|
1164 |
|
|
|
1165 |
|
|
|
1166 |
|
|
|
1167 |
|
|
|
1168 |
</div>
|
|
|
1169 |
|
|
|
1170 |
</div>
|
|
|
1171 |
<hr />
|
|
|
1172 |
</div>
|
|
|
1173 |
<div class="private" rel="yui:method" resource="#method__setHeader">
|
|
|
1174 |
<h4>
|
|
|
1175 |
<a name="method__setHeader">_setHeader</a></h4>
|
|
|
1176 |
<div class="detail" >
|
|
|
1177 |
<code>
|
|
|
1178 |
private
|
|
|
1179 |
static
|
|
|
1180 |
|
|
|
1181 |
|
|
|
1182 |
<strong property="yui:name">_setHeader</strong>
|
|
|
1183 |
(
|
|
|
1184 |
|
|
|
1185 |
|
|
|
1186 |
l
|
|
|
1187 |
|
|
|
1188 |
|
|
|
1189 |
,
|
|
|
1190 |
v
|
|
|
1191 |
|
|
|
1192 |
|
|
|
1193 |
)
|
|
|
1194 |
</code>
|
|
|
1195 |
|
|
|
1196 |
<div class="description" property="yui:description">
|
|
|
1197 |
Method that stores default client headers for all transactions.
|
|
|
1198 |
If a label is passed with no value argument, the header will be deleted.
|
|
|
1199 |
</div>
|
|
|
1200 |
|
|
|
1201 |
<div class="description">
|
|
|
1202 |
|
|
|
1203 |
<dl rel="yui:parameters">
|
|
|
1204 |
<dt>Parameters:</dt>
|
|
|
1205 |
<dd rel="yui:parameter">
|
|
|
1206 |
<code><span property="yui:name">l</span>
|
|
|
1207 |
<<span property="yui:type">string</span>>
|
|
|
1208 |
</code>
|
|
|
1209 |
<span property="yui:description"> - HTTP header</span>
|
|
|
1210 |
</dd>
|
|
|
1211 |
<dd rel="yui:parameter">
|
|
|
1212 |
<code><span property="yui:name">v</span>
|
|
|
1213 |
<<span property="yui:type">string</span>>
|
|
|
1214 |
</code>
|
|
|
1215 |
<span property="yui:description"> - HTTP header value</span>
|
|
|
1216 |
</dd>
|
|
|
1217 |
</dl>
|
|
|
1218 |
|
|
|
1219 |
|
|
|
1220 |
|
|
|
1221 |
|
|
|
1222 |
|
|
|
1223 |
</div>
|
|
|
1224 |
|
|
|
1225 |
</div>
|
|
|
1226 |
<hr />
|
|
|
1227 |
</div>
|
|
|
1228 |
<div class="private" rel="yui:method" resource="#method__setHeaders">
|
|
|
1229 |
<h4>
|
|
|
1230 |
<a name="method__setHeaders">_setHeaders</a></h4>
|
|
|
1231 |
<div class="detail" >
|
|
|
1232 |
<code>
|
|
|
1233 |
private
|
|
|
1234 |
static
|
|
|
1235 |
|
|
|
1236 |
|
|
|
1237 |
<strong property="yui:name">_setHeaders</strong>
|
|
|
1238 |
(
|
|
|
1239 |
|
|
|
1240 |
|
|
|
1241 |
o
|
|
|
1242 |
|
|
|
1243 |
|
|
|
1244 |
,
|
|
|
1245 |
h
|
|
|
1246 |
|
|
|
1247 |
|
|
|
1248 |
)
|
|
|
1249 |
</code>
|
|
|
1250 |
|
|
|
1251 |
<div class="description" property="yui:description">
|
|
|
1252 |
Method that sets all HTTP headers to be sent in a transaction.
|
|
|
1253 |
</div>
|
|
|
1254 |
|
|
|
1255 |
<div class="description">
|
|
|
1256 |
|
|
|
1257 |
<dl rel="yui:parameters">
|
|
|
1258 |
<dt>Parameters:</dt>
|
|
|
1259 |
<dd rel="yui:parameter">
|
|
|
1260 |
<code><span property="yui:name">o</span>
|
|
|
1261 |
<<span property="yui:type">object</span>>
|
|
|
1262 |
</code>
|
|
|
1263 |
<span property="yui:description"> - XHR instance for the specific transaction.</span>
|
|
|
1264 |
</dd>
|
|
|
1265 |
<dd rel="yui:parameter">
|
|
|
1266 |
<code><span property="yui:name">h</span>
|
|
|
1267 |
<<span property="yui:type">object</span>>
|
|
|
1268 |
</code>
|
|
|
1269 |
<span property="yui:description"> - HTTP headers for the specific transaction, as defined
|
|
|
1270 |
in the configuration object passed to YUI.io().</span>
|
|
|
1271 |
</dd>
|
|
|
1272 |
</dl>
|
|
|
1273 |
|
|
|
1274 |
|
|
|
1275 |
|
|
|
1276 |
|
|
|
1277 |
|
|
|
1278 |
</div>
|
|
|
1279 |
|
|
|
1280 |
</div>
|
|
|
1281 |
<hr />
|
|
|
1282 |
</div>
|
|
|
1283 |
<div class="private" rel="yui:method" resource="#method__shift">
|
|
|
1284 |
<h4>
|
|
|
1285 |
<a name="method__shift">_shift</a></h4>
|
|
|
1286 |
<div class="detail" >
|
|
|
1287 |
<code>
|
|
|
1288 |
private
|
|
|
1289 |
static
|
|
|
1290 |
|
|
|
1291 |
|
|
|
1292 |
<strong property="yui:name">_shift</strong>
|
|
|
1293 |
(
|
|
|
1294 |
)
|
|
|
1295 |
</code>
|
|
|
1296 |
|
|
|
1297 |
<div class="description" property="yui:description">
|
|
|
1298 |
Method Process the first transaction from the
|
|
|
1299 |
queue in FIFO order.
|
|
|
1300 |
</div>
|
|
|
1301 |
|
|
|
1302 |
<div class="description">
|
|
|
1303 |
|
|
|
1304 |
|
|
|
1305 |
|
|
|
1306 |
|
|
|
1307 |
|
|
|
1308 |
|
|
|
1309 |
</div>
|
|
|
1310 |
|
|
|
1311 |
</div>
|
|
|
1312 |
<hr />
|
|
|
1313 |
</div>
|
|
|
1314 |
<div class="private" rel="yui:method" resource="#method__size">
|
|
|
1315 |
<h4>
|
|
|
1316 |
<a name="method__size">_size</a></h4>
|
|
|
1317 |
<div class="detail" >
|
|
|
1318 |
<code>
|
|
|
1319 |
private
|
|
|
1320 |
static
|
|
|
1321 |
|
|
|
1322 |
|
|
|
1323 |
<strong property="yui:name">_size</strong>
|
|
|
1324 |
(
|
|
|
1325 |
)
|
|
|
1326 |
</code>
|
|
|
1327 |
|
|
|
1328 |
<div class="description" property="yui:description">
|
|
|
1329 |
Method to query the current size of the queue.
|
|
|
1330 |
</div>
|
|
|
1331 |
|
|
|
1332 |
<div class="description">
|
|
|
1333 |
|
|
|
1334 |
|
|
|
1335 |
|
|
|
1336 |
|
|
|
1337 |
|
|
|
1338 |
|
|
|
1339 |
</div>
|
|
|
1340 |
|
|
|
1341 |
</div>
|
|
|
1342 |
<hr />
|
|
|
1343 |
</div>
|
|
|
1344 |
<div class="private" rel="yui:method" resource="#method__startTimeout">
|
|
|
1345 |
<h4>
|
|
|
1346 |
<a name="method__startTimeout">_startTimeout</a></h4>
|
|
|
1347 |
<div class="detail" >
|
|
|
1348 |
<code>
|
|
|
1349 |
private
|
|
|
1350 |
static
|
|
|
1351 |
|
|
|
1352 |
|
|
|
1353 |
<strong property="yui:name">_startTimeout</strong>
|
|
|
1354 |
(
|
|
|
1355 |
|
|
|
1356 |
|
|
|
1357 |
o
|
|
|
1358 |
|
|
|
1359 |
|
|
|
1360 |
,
|
|
|
1361 |
c
|
|
|
1362 |
|
|
|
1363 |
|
|
|
1364 |
)
|
|
|
1365 |
</code>
|
|
|
1366 |
|
|
|
1367 |
<div class="description" property="yui:description">
|
|
|
1368 |
Starts timeout count if the configuration object
|
|
|
1369 |
has a defined timeout property.
|
|
|
1370 |
</div>
|
|
|
1371 |
|
|
|
1372 |
<div class="description">
|
|
|
1373 |
|
|
|
1374 |
<dl rel="yui:parameters">
|
|
|
1375 |
<dt>Parameters:</dt>
|
|
|
1376 |
<dd rel="yui:parameter">
|
|
|
1377 |
<code><span property="yui:name">o</span>
|
|
|
1378 |
<<span property="yui:type">object</span>>
|
|
|
1379 |
</code>
|
|
|
1380 |
<span property="yui:description"> - Transaction object generated by _create().</span>
|
|
|
1381 |
</dd>
|
|
|
1382 |
<dd rel="yui:parameter">
|
|
|
1383 |
<code><span property="yui:name">c</span>
|
|
|
1384 |
<<span property="yui:type">object</span>>
|
|
|
1385 |
</code>
|
|
|
1386 |
<span property="yui:description"> - Configuration object passed to YUI.io().</span>
|
|
|
1387 |
</dd>
|
|
|
1388 |
</dl>
|
|
|
1389 |
|
|
|
1390 |
|
|
|
1391 |
|
|
|
1392 |
|
|
|
1393 |
|
|
|
1394 |
</div>
|
|
|
1395 |
|
|
|
1396 |
</div>
|
|
|
1397 |
<hr />
|
|
|
1398 |
</div>
|
|
|
1399 |
<div class="private" rel="yui:method" resource="#method__stop">
|
|
|
1400 |
<h4>
|
|
|
1401 |
<a name="method__stop">_stop</a></h4>
|
|
|
1402 |
<div class="detail" >
|
|
|
1403 |
<code>
|
|
|
1404 |
private
|
|
|
1405 |
static
|
|
|
1406 |
|
|
|
1407 |
|
|
|
1408 |
<strong property="yui:name">_stop</strong>
|
|
|
1409 |
(
|
|
|
1410 |
)
|
|
|
1411 |
</code>
|
|
|
1412 |
|
|
|
1413 |
<div class="description" property="yui:description">
|
|
|
1414 |
Method for setting queue processing to inactive.
|
|
|
1415 |
Transaction requests to YUI.io.queue() will be stored in the queue, but
|
|
|
1416 |
not processed until the queue is reset to "active".
|
|
|
1417 |
</div>
|
|
|
1418 |
|
|
|
1419 |
<div class="description">
|
|
|
1420 |
|
|
|
1421 |
|
|
|
1422 |
|
|
|
1423 |
|
|
|
1424 |
|
|
|
1425 |
|
|
|
1426 |
</div>
|
|
|
1427 |
|
|
|
1428 |
</div>
|
|
|
1429 |
<hr />
|
|
|
1430 |
</div>
|
|
|
1431 |
<div class="private" rel="yui:method" resource="#method__swf">
|
|
|
1432 |
<h4>
|
|
|
1433 |
<a name="method__swf">_swf</a></h4>
|
|
|
1434 |
<div class="detail" >
|
|
|
1435 |
<code>
|
|
|
1436 |
private
|
|
|
1437 |
static
|
|
|
1438 |
|
|
|
1439 |
|
|
|
1440 |
<strong property="yui:name">_swf</strong>
|
|
|
1441 |
(
|
|
|
1442 |
|
|
|
1443 |
|
|
|
1444 |
uri
|
|
|
1445 |
|
|
|
1446 |
|
|
|
1447 |
,
|
|
|
1448 |
yid
|
|
|
1449 |
|
|
|
1450 |
|
|
|
1451 |
)
|
|
|
1452 |
</code>
|
|
|
1453 |
|
|
|
1454 |
<div class="description" property="yui:description">
|
|
|
1455 |
Method that creates the Flash transport swf.
|
|
|
1456 |
</div>
|
|
|
1457 |
|
|
|
1458 |
<div class="description">
|
|
|
1459 |
|
|
|
1460 |
<dl rel="yui:parameters">
|
|
|
1461 |
<dt>Parameters:</dt>
|
|
|
1462 |
<dd rel="yui:parameter">
|
|
|
1463 |
<code><span property="yui:name">uri</span>
|
|
|
1464 |
<<span property="yui:type">string</span>>
|
|
|
1465 |
</code>
|
|
|
1466 |
<span property="yui:description"> - location of IO.swf.</span>
|
|
|
1467 |
</dd>
|
|
|
1468 |
<dd rel="yui:parameter">
|
|
|
1469 |
<code><span property="yui:name">yid</span>
|
|
|
1470 |
<<span property="yui:type">string</span>>
|
|
|
1471 |
</code>
|
|
|
1472 |
<span property="yui:description"> - YUI instance id.</span>
|
|
|
1473 |
</dd>
|
|
|
1474 |
</dl>
|
|
|
1475 |
|
|
|
1476 |
|
|
|
1477 |
|
|
|
1478 |
|
|
|
1479 |
|
|
|
1480 |
</div>
|
|
|
1481 |
|
|
|
1482 |
</div>
|
|
|
1483 |
<hr />
|
|
|
1484 |
</div>
|
|
|
1485 |
<div class="private" rel="yui:method" resource="#method__tPubSub">
|
|
|
1486 |
<h4>
|
|
|
1487 |
<a name="method__tPubSub">_tPubSub</a></h4>
|
|
|
1488 |
<div class="detail" >
|
|
|
1489 |
<code>
|
|
|
1490 |
private
|
|
|
1491 |
static
|
|
|
1492 |
|
|
|
1493 |
|
|
|
1494 |
<strong property="yui:name">_tPubSub</strong>
|
|
|
1495 |
(
|
|
|
1496 |
|
|
|
1497 |
|
|
|
1498 |
e
|
|
|
1499 |
|
|
|
1500 |
|
|
|
1501 |
,
|
|
|
1502 |
c
|
|
|
1503 |
|
|
|
1504 |
|
|
|
1505 |
)
|
|
|
1506 |
</code>
|
|
|
1507 |
|
|
|
1508 |
<div class="description" property="yui:description">
|
|
|
1509 |
Method for creating and subscribing transaction events.
|
|
|
1510 |
</div>
|
|
|
1511 |
|
|
|
1512 |
<div class="description">
|
|
|
1513 |
|
|
|
1514 |
<dl rel="yui:parameters">
|
|
|
1515 |
<dt>Parameters:</dt>
|
|
|
1516 |
<dd rel="yui:parameter">
|
|
|
1517 |
<code><span property="yui:name">e</span>
|
|
|
1518 |
<<span property="yui:type">string</span>>
|
|
|
1519 |
</code>
|
|
|
1520 |
<span property="yui:description"> - event to be published</span>
|
|
|
1521 |
</dd>
|
|
|
1522 |
<dd rel="yui:parameter">
|
|
|
1523 |
<code><span property="yui:name">c</span>
|
|
|
1524 |
<<span property="yui:type">object</span>>
|
|
|
1525 |
</code>
|
|
|
1526 |
<span property="yui:description"> - configuration data subset for event subscription.</span>
|
|
|
1527 |
</dd>
|
|
|
1528 |
</dl>
|
|
|
1529 |
|
|
|
1530 |
|
|
|
1531 |
|
|
|
1532 |
|
|
|
1533 |
|
|
|
1534 |
</div>
|
|
|
1535 |
|
|
|
1536 |
</div>
|
|
|
1537 |
<hr />
|
|
|
1538 |
</div>
|
|
|
1539 |
<div class="private" rel="yui:method" resource="#method__unshift">
|
|
|
1540 |
<h4>
|
|
|
1541 |
<a name="method__unshift">_unshift</a></h4>
|
|
|
1542 |
<div class="detail" >
|
|
|
1543 |
<code>
|
|
|
1544 |
private
|
|
|
1545 |
static
|
|
|
1546 |
|
|
|
1547 |
|
|
|
1548 |
<strong property="yui:name">_unshift</strong>
|
|
|
1549 |
(
|
|
|
1550 |
)
|
|
|
1551 |
</code>
|
|
|
1552 |
|
|
|
1553 |
<div class="description" property="yui:description">
|
|
|
1554 |
Method for promoting a transaction to the top of the queue.
|
|
|
1555 |
</div>
|
|
|
1556 |
|
|
|
1557 |
<div class="description">
|
|
|
1558 |
|
|
|
1559 |
|
|
|
1560 |
|
|
|
1561 |
|
|
|
1562 |
|
|
|
1563 |
|
|
|
1564 |
</div>
|
|
|
1565 |
|
|
|
1566 |
</div>
|
|
|
1567 |
<hr />
|
|
|
1568 |
</div>
|
|
|
1569 |
<div class="private" rel="yui:method" resource="#method__upload">
|
|
|
1570 |
<h4>
|
|
|
1571 |
<a name="method__upload">_upload</a></h4>
|
|
|
1572 |
<div class="detail" >
|
|
|
1573 |
<code>
|
|
|
1574 |
private
|
|
|
1575 |
static
|
|
|
1576 |
|
|
|
1577 |
void
|
|
|
1578 |
<strong property="yui:name">_upload</strong>
|
|
|
1579 |
(
|
|
|
1580 |
|
|
|
1581 |
|
|
|
1582 |
o
|
|
|
1583 |
|
|
|
1584 |
|
|
|
1585 |
,
|
|
|
1586 |
uri
|
|
|
1587 |
|
|
|
1588 |
|
|
|
1589 |
,
|
|
|
1590 |
c
|
|
|
1591 |
|
|
|
1592 |
|
|
|
1593 |
)
|
|
|
1594 |
</code>
|
|
|
1595 |
|
|
|
1596 |
<div class="description" property="yui:description">
|
|
|
1597 |
Uploads HTML form, inclusive of files/attachments, using the
|
|
|
1598 |
iframe created in createFrame to facilitate the transaction.
|
|
|
1599 |
</div>
|
|
|
1600 |
|
|
|
1601 |
<div class="description">
|
|
|
1602 |
|
|
|
1603 |
<dl rel="yui:parameters">
|
|
|
1604 |
<dt>Parameters:</dt>
|
|
|
1605 |
<dd rel="yui:parameter">
|
|
|
1606 |
<code><span property="yui:name">o</span>
|
|
|
1607 |
<<span property="yui:type">o</span>>
|
|
|
1608 |
</code>
|
|
|
1609 |
<span property="yui:description"> The transaction object</span>
|
|
|
1610 |
</dd>
|
|
|
1611 |
<dd rel="yui:parameter">
|
|
|
1612 |
<code><span property="yui:name">uri</span>
|
|
|
1613 |
<<span property="yui:type">object</span>>
|
|
|
1614 |
</code>
|
|
|
1615 |
<span property="yui:description"> Qualified path to transaction resource.</span>
|
|
|
1616 |
</dd>
|
|
|
1617 |
<dd rel="yui:parameter">
|
|
|
1618 |
<code><span property="yui:name">c</span>
|
|
|
1619 |
<<span property="yui:type">object</span>>
|
|
|
1620 |
</code>
|
|
|
1621 |
<span property="yui:description"> Configuration object for the transaction.</span>
|
|
|
1622 |
</dd>
|
|
|
1623 |
</dl>
|
|
|
1624 |
|
|
|
1625 |
<dl>
|
|
|
1626 |
<dt>Returns:
|
|
|
1627 |
<code property="yui:return">
|
|
|
1628 |
void
|
|
|
1629 |
</code></dt>
|
|
|
1630 |
<dd property="yui:returnInfo"></dd>
|
|
|
1631 |
</dl>
|
|
|
1632 |
|
|
|
1633 |
|
|
|
1634 |
|
|
|
1635 |
|
|
|
1636 |
</div>
|
|
|
1637 |
|
|
|
1638 |
</div>
|
|
|
1639 |
<hr />
|
|
|
1640 |
</div>
|
|
|
1641 |
<div class="private" rel="yui:method" resource="#method__xdr">
|
|
|
1642 |
<h4>
|
|
|
1643 |
<a name="method__xdr">_xdr</a></h4>
|
|
|
1644 |
<div class="detail" >
|
|
|
1645 |
<code>
|
|
|
1646 |
private
|
|
|
1647 |
static
|
|
|
1648 |
|
|
|
1649 |
|
|
|
1650 |
<strong property="yui:name">_xdr</strong>
|
|
|
1651 |
(
|
|
|
1652 |
|
|
|
1653 |
|
|
|
1654 |
uri
|
|
|
1655 |
|
|
|
1656 |
|
|
|
1657 |
,
|
|
|
1658 |
o
|
|
|
1659 |
|
|
|
1660 |
|
|
|
1661 |
,
|
|
|
1662 |
c
|
|
|
1663 |
|
|
|
1664 |
|
|
|
1665 |
)
|
|
|
1666 |
</code>
|
|
|
1667 |
|
|
|
1668 |
<div class="description" property="yui:description">
|
|
|
1669 |
Method for accessing the transport's interface for making a
|
|
|
1670 |
cross-domain transaction.
|
|
|
1671 |
</div>
|
|
|
1672 |
|
|
|
1673 |
<div class="description">
|
|
|
1674 |
|
|
|
1675 |
<dl rel="yui:parameters">
|
|
|
1676 |
<dt>Parameters:</dt>
|
|
|
1677 |
<dd rel="yui:parameter">
|
|
|
1678 |
<code><span property="yui:name">uri</span>
|
|
|
1679 |
<<span property="yui:type">string</span>>
|
|
|
1680 |
</code>
|
|
|
1681 |
<span property="yui:description"> - qualified path to transaction resource.</span>
|
|
|
1682 |
</dd>
|
|
|
1683 |
<dd rel="yui:parameter">
|
|
|
1684 |
<code><span property="yui:name">o</span>
|
|
|
1685 |
<<span property="yui:type">object</span>>
|
|
|
1686 |
</code>
|
|
|
1687 |
<span property="yui:description"> - Transaction object generated by _create() in io-base.</span>
|
|
|
1688 |
</dd>
|
|
|
1689 |
<dd rel="yui:parameter">
|
|
|
1690 |
<code><span property="yui:name">c</span>
|
|
|
1691 |
<<span property="yui:type">object</span>>
|
|
|
1692 |
</code>
|
|
|
1693 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
1694 |
</dd>
|
|
|
1695 |
</dl>
|
|
|
1696 |
|
|
|
1697 |
|
|
|
1698 |
|
|
|
1699 |
|
|
|
1700 |
|
|
|
1701 |
</div>
|
|
|
1702 |
|
|
|
1703 |
</div>
|
|
|
1704 |
<hr />
|
|
|
1705 |
</div>
|
|
|
1706 |
<div class="private" rel="yui:method" resource="#method__xhr">
|
|
|
1707 |
<h4>
|
|
|
1708 |
<a name="method__xhr">_xhr</a></h4>
|
|
|
1709 |
<div class="detail" >
|
|
|
1710 |
<code>
|
|
|
1711 |
private
|
|
|
1712 |
static
|
|
|
1713 |
|
|
|
1714 |
|
|
|
1715 |
<strong property="yui:name">_xhr</strong>
|
|
|
1716 |
(
|
|
|
1717 |
)
|
|
|
1718 |
</code>
|
|
|
1719 |
|
|
|
1720 |
<div class="description" property="yui:description">
|
|
|
1721 |
Method that creates the XMLHttpRequest transport
|
|
|
1722 |
</div>
|
|
|
1723 |
|
|
|
1724 |
<div class="description">
|
|
|
1725 |
|
|
|
1726 |
|
|
|
1727 |
|
|
|
1728 |
|
|
|
1729 |
|
|
|
1730 |
|
|
|
1731 |
</div>
|
|
|
1732 |
|
|
|
1733 |
</div>
|
|
|
1734 |
<hr />
|
|
|
1735 |
</div>
|
|
|
1736 |
<div class="private" rel="yui:method" resource="#method_appendData">
|
|
|
1737 |
<h4>
|
|
|
1738 |
<a name="method_appendData">appendData</a></h4>
|
|
|
1739 |
<div class="detail" >
|
|
|
1740 |
<code>
|
|
|
1741 |
private
|
|
|
1742 |
static
|
|
|
1743 |
|
|
|
1744 |
array
|
|
|
1745 |
<strong property="yui:name">appendData</strong>
|
|
|
1746 |
(
|
|
|
1747 |
|
|
|
1748 |
|
|
|
1749 |
d
|
|
|
1750 |
|
|
|
1751 |
|
|
|
1752 |
)
|
|
|
1753 |
</code>
|
|
|
1754 |
|
|
|
1755 |
<div class="description" property="yui:description">
|
|
|
1756 |
Parses the POST data object and creates hidden form elements
|
|
|
1757 |
for each key-value, and appends them to the HTML form object.
|
|
|
1758 |
</div>
|
|
|
1759 |
|
|
|
1760 |
<div class="description">
|
|
|
1761 |
|
|
|
1762 |
<dl rel="yui:parameters">
|
|
|
1763 |
<dt>Parameters:</dt>
|
|
|
1764 |
<dd rel="yui:parameter">
|
|
|
1765 |
<code><span property="yui:name">d</span>
|
|
|
1766 |
<<span property="yui:type">object</span>>
|
|
|
1767 |
</code>
|
|
|
1768 |
<span property="yui:description"> The key-value hash map.</span>
|
|
|
1769 |
</dd>
|
|
|
1770 |
</dl>
|
|
|
1771 |
|
|
|
1772 |
<dl>
|
|
|
1773 |
<dt>Returns:
|
|
|
1774 |
<code property="yui:return">
|
|
|
1775 |
array
|
|
|
1776 |
</code></dt>
|
|
|
1777 |
<dd property="yui:returnInfo">e Array of created fields.</dd>
|
|
|
1778 |
</dl>
|
|
|
1779 |
|
|
|
1780 |
|
|
|
1781 |
|
|
|
1782 |
|
|
|
1783 |
</div>
|
|
|
1784 |
|
|
|
1785 |
</div>
|
|
|
1786 |
<hr />
|
|
|
1787 |
</div>
|
|
|
1788 |
<div class="" rel="yui:method" resource="#method_header">
|
|
|
1789 |
<h4>
|
|
|
1790 |
<a name="method_header">header</a></h4>
|
|
|
1791 |
<div class="detail" >
|
|
|
1792 |
<code>
|
|
|
1793 |
|
|
|
1794 |
static
|
|
|
1795 |
|
|
|
1796 |
|
|
|
1797 |
<strong property="yui:name">header</strong>
|
|
|
1798 |
(
|
|
|
1799 |
|
|
|
1800 |
|
|
|
1801 |
l
|
|
|
1802 |
|
|
|
1803 |
|
|
|
1804 |
,
|
|
|
1805 |
v
|
|
|
1806 |
|
|
|
1807 |
|
|
|
1808 |
)
|
|
|
1809 |
</code>
|
|
|
1810 |
|
|
|
1811 |
<div class="description" property="yui:description">
|
|
|
1812 |
Method that stores default client headers for all transactions.
|
|
|
1813 |
If a label is passed with no value argument, the header will be deleted.
|
|
|
1814 |
This is the interface for _setHeader().
|
|
|
1815 |
</div>
|
|
|
1816 |
|
|
|
1817 |
<div class="description">
|
|
|
1818 |
|
|
|
1819 |
<dl rel="yui:parameters">
|
|
|
1820 |
<dt>Parameters:</dt>
|
|
|
1821 |
<dd rel="yui:parameter">
|
|
|
1822 |
<code><span property="yui:name">l</span>
|
|
|
1823 |
<<span property="yui:type">string</span>>
|
|
|
1824 |
</code>
|
|
|
1825 |
<span property="yui:description"> - HTTP header</span>
|
|
|
1826 |
</dd>
|
|
|
1827 |
<dd rel="yui:parameter">
|
|
|
1828 |
<code><span property="yui:name">v</span>
|
|
|
1829 |
<<span property="yui:type">string</span>>
|
|
|
1830 |
</code>
|
|
|
1831 |
<span property="yui:description"> - HTTP header value</span>
|
|
|
1832 |
</dd>
|
|
|
1833 |
</dl>
|
|
|
1834 |
|
|
|
1835 |
|
|
|
1836 |
|
|
|
1837 |
|
|
|
1838 |
|
|
|
1839 |
</div>
|
|
|
1840 |
|
|
|
1841 |
</div>
|
|
|
1842 |
<hr />
|
|
|
1843 |
</div>
|
|
|
1844 |
<div class="" rel="yui:method" resource="#method_io">
|
|
|
1845 |
<h4>
|
|
|
1846 |
<a name="method_io">io</a></h4>
|
|
|
1847 |
<div class="detail" >
|
|
|
1848 |
<code>
|
|
|
1849 |
|
|
|
1850 |
static
|
|
|
1851 |
|
|
|
1852 |
|
|
|
1853 |
<strong property="yui:name">io</strong>
|
|
|
1854 |
(
|
|
|
1855 |
|
|
|
1856 |
|
|
|
1857 |
uri
|
|
|
1858 |
|
|
|
1859 |
|
|
|
1860 |
,
|
|
|
1861 |
c
|
|
|
1862 |
|
|
|
1863 |
|
|
|
1864 |
)
|
|
|
1865 |
</code>
|
|
|
1866 |
|
|
|
1867 |
<div class="description" property="yui:description">
|
|
|
1868 |
Method for requesting a transaction. This
|
|
|
1869 |
is the interface for _io().
|
|
|
1870 |
</div>
|
|
|
1871 |
|
|
|
1872 |
<div class="description">
|
|
|
1873 |
|
|
|
1874 |
<dl rel="yui:parameters">
|
|
|
1875 |
<dt>Parameters:</dt>
|
|
|
1876 |
<dd rel="yui:parameter">
|
|
|
1877 |
<code><span property="yui:name">uri</span>
|
|
|
1878 |
<<span property="yui:type">string</span>>
|
|
|
1879 |
</code>
|
|
|
1880 |
<span property="yui:description"> - qualified path to transaction resource.</span>
|
|
|
1881 |
</dd>
|
|
|
1882 |
<dd rel="yui:parameter">
|
|
|
1883 |
<code><span property="yui:name">c</span>
|
|
|
1884 |
<<span property="yui:type">object</span>>
|
|
|
1885 |
</code>
|
|
|
1886 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
1887 |
</dd>
|
|
|
1888 |
</dl>
|
|
|
1889 |
|
|
|
1890 |
|
|
|
1891 |
|
|
|
1892 |
|
|
|
1893 |
|
|
|
1894 |
</div>
|
|
|
1895 |
|
|
|
1896 |
</div>
|
|
|
1897 |
<hr />
|
|
|
1898 |
</div>
|
|
|
1899 |
<div class="" rel="yui:method" resource="#method_promote">
|
|
|
1900 |
<h4>
|
|
|
1901 |
<a name="method_promote">promote</a></h4>
|
|
|
1902 |
<div class="detail" >
|
|
|
1903 |
<code>
|
|
|
1904 |
|
|
|
1905 |
static
|
|
|
1906 |
|
|
|
1907 |
|
|
|
1908 |
<strong property="yui:name">promote</strong>
|
|
|
1909 |
(
|
|
|
1910 |
|
|
|
1911 |
|
|
|
1912 |
o
|
|
|
1913 |
|
|
|
1914 |
|
|
|
1915 |
)
|
|
|
1916 |
</code>
|
|
|
1917 |
|
|
|
1918 |
<div class="description" property="yui:description">
|
|
|
1919 |
Method for promoting a transaction to the top of the queue.
|
|
|
1920 |
This is the interface for _unshift().
|
|
|
1921 |
</div>
|
|
|
1922 |
|
|
|
1923 |
<div class="description">
|
|
|
1924 |
|
|
|
1925 |
<dl rel="yui:parameters">
|
|
|
1926 |
<dt>Parameters:</dt>
|
|
|
1927 |
<dd rel="yui:parameter">
|
|
|
1928 |
<code><span property="yui:name">o</span>
|
|
|
1929 |
<<span property="yui:type">Object</span>>
|
|
|
1930 |
</code>
|
|
|
1931 |
<span property="yui:description"> - Reference to queued transaction.</span>
|
|
|
1932 |
</dd>
|
|
|
1933 |
</dl>
|
|
|
1934 |
|
|
|
1935 |
|
|
|
1936 |
|
|
|
1937 |
|
|
|
1938 |
|
|
|
1939 |
</div>
|
|
|
1940 |
|
|
|
1941 |
</div>
|
|
|
1942 |
<hr />
|
|
|
1943 |
</div>
|
|
|
1944 |
<div class="" rel="yui:method" resource="#method_purge">
|
|
|
1945 |
<h4>
|
|
|
1946 |
<a name="method_purge">purge</a></h4>
|
|
|
1947 |
<div class="detail" >
|
|
|
1948 |
<code>
|
|
|
1949 |
|
|
|
1950 |
static
|
|
|
1951 |
|
|
|
1952 |
|
|
|
1953 |
<strong property="yui:name">purge</strong>
|
|
|
1954 |
(
|
|
|
1955 |
|
|
|
1956 |
|
|
|
1957 |
o
|
|
|
1958 |
|
|
|
1959 |
|
|
|
1960 |
)
|
|
|
1961 |
</code>
|
|
|
1962 |
|
|
|
1963 |
<div class="description" property="yui:description">
|
|
|
1964 |
Method for removing a specific, pending transaction from
|
|
|
1965 |
the queue. This is the interface for _purge().
|
|
|
1966 |
</div>
|
|
|
1967 |
|
|
|
1968 |
<div class="description">
|
|
|
1969 |
|
|
|
1970 |
<dl rel="yui:parameters">
|
|
|
1971 |
<dt>Parameters:</dt>
|
|
|
1972 |
<dd rel="yui:parameter">
|
|
|
1973 |
<code><span property="yui:name">o</span>
|
|
|
1974 |
<<span property="yui:type">Object</span>>
|
|
|
1975 |
</code>
|
|
|
1976 |
<span property="yui:description"> - Reference to queued transaction.</span>
|
|
|
1977 |
</dd>
|
|
|
1978 |
</dl>
|
|
|
1979 |
|
|
|
1980 |
|
|
|
1981 |
|
|
|
1982 |
|
|
|
1983 |
|
|
|
1984 |
</div>
|
|
|
1985 |
|
|
|
1986 |
</div>
|
|
|
1987 |
<hr />
|
|
|
1988 |
</div>
|
|
|
1989 |
<div class="" rel="yui:method" resource="#method_size">
|
|
|
1990 |
<h4>
|
|
|
1991 |
<a name="method_size">size</a></h4>
|
|
|
1992 |
<div class="detail" >
|
|
|
1993 |
<code>
|
|
|
1994 |
|
|
|
1995 |
static
|
|
|
1996 |
|
|
|
1997 |
|
|
|
1998 |
<strong property="yui:name">size</strong>
|
|
|
1999 |
(
|
|
|
2000 |
|
|
|
2001 |
|
|
|
2002 |
i
|
|
|
2003 |
|
|
|
2004 |
|
|
|
2005 |
)
|
|
|
2006 |
</code>
|
|
|
2007 |
|
|
|
2008 |
<div class="description" property="yui:description">
|
|
|
2009 |
Method to query the current size of the queue, or to
|
|
|
2010 |
set a maximum queue size. This is the interface for _size().
|
|
|
2011 |
</div>
|
|
|
2012 |
|
|
|
2013 |
<div class="description">
|
|
|
2014 |
|
|
|
2015 |
<dl rel="yui:parameters">
|
|
|
2016 |
<dt>Parameters:</dt>
|
|
|
2017 |
<dd rel="yui:parameter">
|
|
|
2018 |
<code><span property="yui:name">i</span>
|
|
|
2019 |
<<span property="yui:type">number</span>>
|
|
|
2020 |
</code>
|
|
|
2021 |
<span property="yui:description"> - Specified maximum size of queue.</span>
|
|
|
2022 |
</dd>
|
|
|
2023 |
</dl>
|
|
|
2024 |
|
|
|
2025 |
|
|
|
2026 |
|
|
|
2027 |
|
|
|
2028 |
|
|
|
2029 |
</div>
|
|
|
2030 |
|
|
|
2031 |
</div>
|
|
|
2032 |
<hr />
|
|
|
2033 |
</div>
|
|
|
2034 |
<div class="" rel="yui:method" resource="#method_start">
|
|
|
2035 |
<h4>
|
|
|
2036 |
<a name="method_start">start</a></h4>
|
|
|
2037 |
<div class="detail" >
|
|
|
2038 |
<code>
|
|
|
2039 |
|
|
|
2040 |
static
|
|
|
2041 |
|
|
|
2042 |
|
|
|
2043 |
<strong property="yui:name">start</strong>
|
|
|
2044 |
(
|
|
|
2045 |
)
|
|
|
2046 |
</code>
|
|
|
2047 |
|
|
|
2048 |
<div class="description" property="yui:description">
|
|
|
2049 |
Method for setting the queue to active. If there are
|
|
|
2050 |
transactions pending in the queue, they will be processed from the
|
|
|
2051 |
queue in FIFO order. This is the interface for _start().
|
|
|
2052 |
</div>
|
|
|
2053 |
|
|
|
2054 |
<div class="description">
|
|
|
2055 |
|
|
|
2056 |
|
|
|
2057 |
|
|
|
2058 |
|
|
|
2059 |
|
|
|
2060 |
|
|
|
2061 |
</div>
|
|
|
2062 |
|
|
|
2063 |
</div>
|
|
|
2064 |
<hr />
|
|
|
2065 |
</div>
|
|
|
2066 |
<div class="" rel="yui:method" resource="#method_stop">
|
|
|
2067 |
<h4>
|
|
|
2068 |
<a name="method_stop">stop</a></h4>
|
|
|
2069 |
<div class="detail" >
|
|
|
2070 |
<code>
|
|
|
2071 |
|
|
|
2072 |
static
|
|
|
2073 |
|
|
|
2074 |
|
|
|
2075 |
<strong property="yui:name">stop</strong>
|
|
|
2076 |
(
|
|
|
2077 |
)
|
|
|
2078 |
</code>
|
|
|
2079 |
|
|
|
2080 |
<div class="description" property="yui:description">
|
|
|
2081 |
Method for setting queue processing to inactive.
|
|
|
2082 |
Transaction requests to YUI.io.queue() will be stored in the queue, but
|
|
|
2083 |
not processed until the queue is restarted. This is the
|
|
|
2084 |
interface for _stop().
|
|
|
2085 |
</div>
|
|
|
2086 |
|
|
|
2087 |
<div class="description">
|
|
|
2088 |
|
|
|
2089 |
|
|
|
2090 |
|
|
|
2091 |
|
|
|
2092 |
|
|
|
2093 |
|
|
|
2094 |
</div>
|
|
|
2095 |
|
|
|
2096 |
</div>
|
|
|
2097 |
<hr />
|
|
|
2098 |
</div>
|
|
|
2099 |
<div class="" rel="yui:method" resource="#method_transport">
|
|
|
2100 |
<h4>
|
|
|
2101 |
<a name="method_transport">transport</a></h4>
|
|
|
2102 |
<div class="detail" >
|
|
|
2103 |
<code>
|
|
|
2104 |
|
|
|
2105 |
static
|
|
|
2106 |
|
|
|
2107 |
|
|
|
2108 |
<strong property="yui:name">transport</strong>
|
|
|
2109 |
(
|
|
|
2110 |
|
|
|
2111 |
|
|
|
2112 |
o
|
|
|
2113 |
|
|
|
2114 |
|
|
|
2115 |
)
|
|
|
2116 |
</code>
|
|
|
2117 |
|
|
|
2118 |
<div class="description" property="yui:description">
|
|
|
2119 |
Method to initialize the desired transport.
|
|
|
2120 |
</div>
|
|
|
2121 |
|
|
|
2122 |
<div class="description">
|
|
|
2123 |
|
|
|
2124 |
<dl rel="yui:parameters">
|
|
|
2125 |
<dt>Parameters:</dt>
|
|
|
2126 |
<dd rel="yui:parameter">
|
|
|
2127 |
<code><span property="yui:name">o</span>
|
|
|
2128 |
<<span property="yui:type">object</span>>
|
|
|
2129 |
</code>
|
|
|
2130 |
<span property="yui:description"> - object of transport configurations.</span>
|
|
|
2131 |
</dd>
|
|
|
2132 |
</dl>
|
|
|
2133 |
|
|
|
2134 |
|
|
|
2135 |
|
|
|
2136 |
|
|
|
2137 |
|
|
|
2138 |
</div>
|
|
|
2139 |
|
|
|
2140 |
</div>
|
|
|
2141 |
<hr />
|
|
|
2142 |
</div>
|
|
|
2143 |
<div class="private" rel="yui:method" resource="#method_xdrReady">
|
|
|
2144 |
<h4>
|
|
|
2145 |
<a name="method_xdrReady">xdrReady</a></h4>
|
|
|
2146 |
<div class="detail" >
|
|
|
2147 |
<code>
|
|
|
2148 |
private
|
|
|
2149 |
static
|
|
|
2150 |
|
|
|
2151 |
|
|
|
2152 |
<strong property="yui:name">xdrReady</strong>
|
|
|
2153 |
(
|
|
|
2154 |
|
|
|
2155 |
|
|
|
2156 |
id
|
|
|
2157 |
|
|
|
2158 |
|
|
|
2159 |
,
|
|
|
2160 |
c
|
|
|
2161 |
|
|
|
2162 |
|
|
|
2163 |
)
|
|
|
2164 |
</code>
|
|
|
2165 |
|
|
|
2166 |
<div class="description" property="yui:description">
|
|
|
2167 |
Fires event "io:xdrReady"
|
|
|
2168 |
</div>
|
|
|
2169 |
|
|
|
2170 |
<div class="description">
|
|
|
2171 |
|
|
|
2172 |
<dl rel="yui:parameters">
|
|
|
2173 |
<dt>Parameters:</dt>
|
|
|
2174 |
<dd rel="yui:parameter">
|
|
|
2175 |
<code><span property="yui:name">id</span>
|
|
|
2176 |
<<span property="yui:type">number</span>>
|
|
|
2177 |
</code>
|
|
|
2178 |
<span property="yui:description"> - transaction id</span>
|
|
|
2179 |
</dd>
|
|
|
2180 |
<dd rel="yui:parameter">
|
|
|
2181 |
<code><span property="yui:name">c</span>
|
|
|
2182 |
<<span property="yui:type">object</span>>
|
|
|
2183 |
</code>
|
|
|
2184 |
<span property="yui:description"> - configuration object for the transaction.</span>
|
|
|
2185 |
</dd>
|
|
|
2186 |
</dl>
|
|
|
2187 |
|
|
|
2188 |
|
|
|
2189 |
|
|
|
2190 |
|
|
|
2191 |
|
|
|
2192 |
</div>
|
|
|
2193 |
|
|
|
2194 |
</div>
|
|
|
2195 |
<hr />
|
|
|
2196 |
</div>
|
|
|
2197 |
</div>
|
|
|
2198 |
</div>
|
|
|
2199 |
|
|
|
2200 |
</div>
|
|
|
2201 |
|
|
|
2202 |
<div rel="yui:events" resource="#events">
|
|
|
2203 |
<div class="section method details">
|
|
|
2204 |
<h3 id="events">Events</h3>
|
|
|
2205 |
<div class="content">
|
|
|
2206 |
<div class="" rel="yui:event" resource="#event_io:complete">
|
|
|
2207 |
<h4>
|
|
|
2208 |
<a name="event_io:complete">io:complete</a></h4>
|
|
|
2209 |
<div class="detail">
|
|
|
2210 |
<code>
|
|
|
2211 |
|
|
|
2212 |
|
|
|
2213 |
|
|
|
2214 |
<strong property="yui:name">io:complete</strong>
|
|
|
2215 |
|
|
|
2216 |
(
|
|
|
2217 |
)
|
|
|
2218 |
|
|
|
2219 |
</code>
|
|
|
2220 |
|
|
|
2221 |
<div class="description" property="yui:description">
|
|
|
2222 |
This event is fired by YUI.io when a transaction is complete.
|
|
|
2223 |
Response status and data are accessible, if available.
|
|
|
2224 |
</div>
|
|
|
2225 |
|
|
|
2226 |
<div class="description">
|
|
|
2227 |
|
|
|
2228 |
|
|
|
2229 |
|
|
|
2230 |
|
|
|
2231 |
</div>
|
|
|
2232 |
|
|
|
2233 |
</div>
|
|
|
2234 |
<hr />
|
|
|
2235 |
</div>
|
|
|
2236 |
<div class="" rel="yui:event" resource="#event_io:end">
|
|
|
2237 |
<h4>
|
|
|
2238 |
<a name="event_io:end">io:end</a></h4>
|
|
|
2239 |
<div class="detail">
|
|
|
2240 |
<code>
|
|
|
2241 |
|
|
|
2242 |
|
|
|
2243 |
|
|
|
2244 |
<strong property="yui:name">io:end</strong>
|
|
|
2245 |
|
|
|
2246 |
(
|
|
|
2247 |
)
|
|
|
2248 |
|
|
|
2249 |
</code>
|
|
|
2250 |
|
|
|
2251 |
<div class="description" property="yui:description">
|
|
|
2252 |
This event signifies the end of the transaction lifecycle. The
|
|
|
2253 |
transaction transport is destroyed.
|
|
|
2254 |
</div>
|
|
|
2255 |
|
|
|
2256 |
<div class="description">
|
|
|
2257 |
|
|
|
2258 |
|
|
|
2259 |
|
|
|
2260 |
|
|
|
2261 |
</div>
|
|
|
2262 |
|
|
|
2263 |
</div>
|
|
|
2264 |
<hr />
|
|
|
2265 |
</div>
|
|
|
2266 |
<div class="" rel="yui:event" resource="#event_io:failure">
|
|
|
2267 |
<h4>
|
|
|
2268 |
<a name="event_io:failure">io:failure</a></h4>
|
|
|
2269 |
<div class="detail">
|
|
|
2270 |
<code>
|
|
|
2271 |
|
|
|
2272 |
|
|
|
2273 |
|
|
|
2274 |
<strong property="yui:name">io:failure</strong>
|
|
|
2275 |
|
|
|
2276 |
(
|
|
|
2277 |
)
|
|
|
2278 |
|
|
|
2279 |
</code>
|
|
|
2280 |
|
|
|
2281 |
<div class="description" property="yui:description">
|
|
|
2282 |
This event is fired by YUI.io when a transaction is complete, and
|
|
|
2283 |
the HTTP status resolves to HTTP4xx, 5xx and above.
|
|
|
2284 |
</div>
|
|
|
2285 |
|
|
|
2286 |
<div class="description">
|
|
|
2287 |
|
|
|
2288 |
|
|
|
2289 |
|
|
|
2290 |
|
|
|
2291 |
</div>
|
|
|
2292 |
|
|
|
2293 |
</div>
|
|
|
2294 |
<hr />
|
|
|
2295 |
</div>
|
|
|
2296 |
<div class="" rel="yui:event" resource="#event_io:start">
|
|
|
2297 |
<h4>
|
|
|
2298 |
<a name="event_io:start">io:start</a></h4>
|
|
|
2299 |
<div class="detail">
|
|
|
2300 |
<code>
|
|
|
2301 |
|
|
|
2302 |
|
|
|
2303 |
|
|
|
2304 |
<strong property="yui:name">io:start</strong>
|
|
|
2305 |
|
|
|
2306 |
(
|
|
|
2307 |
)
|
|
|
2308 |
|
|
|
2309 |
</code>
|
|
|
2310 |
|
|
|
2311 |
<div class="description" property="yui:description">
|
|
|
2312 |
This event is fired by YUI.io when a transaction is initiated.
|
|
|
2313 |
</div>
|
|
|
2314 |
|
|
|
2315 |
<div class="description">
|
|
|
2316 |
|
|
|
2317 |
|
|
|
2318 |
|
|
|
2319 |
|
|
|
2320 |
</div>
|
|
|
2321 |
|
|
|
2322 |
</div>
|
|
|
2323 |
<hr />
|
|
|
2324 |
</div>
|
|
|
2325 |
<div class="" rel="yui:event" resource="#event_io:success">
|
|
|
2326 |
<h4>
|
|
|
2327 |
<a name="event_io:success">io:success</a></h4>
|
|
|
2328 |
<div class="detail">
|
|
|
2329 |
<code>
|
|
|
2330 |
|
|
|
2331 |
|
|
|
2332 |
|
|
|
2333 |
<strong property="yui:name">io:success</strong>
|
|
|
2334 |
|
|
|
2335 |
(
|
|
|
2336 |
)
|
|
|
2337 |
|
|
|
2338 |
</code>
|
|
|
2339 |
|
|
|
2340 |
<div class="description" property="yui:description">
|
|
|
2341 |
This event is fired by YUI.io when a transaction is complete, and
|
|
|
2342 |
the HTTP status resolves to HTTP2xx.
|
|
|
2343 |
</div>
|
|
|
2344 |
|
|
|
2345 |
<div class="description">
|
|
|
2346 |
|
|
|
2347 |
|
|
|
2348 |
|
|
|
2349 |
|
|
|
2350 |
</div>
|
|
|
2351 |
|
|
|
2352 |
</div>
|
|
|
2353 |
<hr />
|
|
|
2354 |
</div>
|
|
|
2355 |
<div class="" rel="yui:event" resource="#event_io:xdrReady">
|
|
|
2356 |
<h4>
|
|
|
2357 |
<a name="event_io:xdrReady">io:xdrReady</a></h4>
|
|
|
2358 |
<div class="detail">
|
|
|
2359 |
<code>
|
|
|
2360 |
|
|
|
2361 |
|
|
|
2362 |
|
|
|
2363 |
<strong property="yui:name">io:xdrReady</strong>
|
|
|
2364 |
|
|
|
2365 |
(
|
|
|
2366 |
)
|
|
|
2367 |
|
|
|
2368 |
</code>
|
|
|
2369 |
|
|
|
2370 |
<div class="description" property="yui:description">
|
|
|
2371 |
This event is fired by YUI.io when the specified transport is
|
|
|
2372 |
ready for use.
|
|
|
2373 |
</div>
|
|
|
2374 |
|
|
|
2375 |
<div class="description">
|
|
|
2376 |
|
|
|
2377 |
|
|
|
2378 |
|
|
|
2379 |
|
|
|
2380 |
</div>
|
|
|
2381 |
|
|
|
2382 |
</div>
|
|
|
2383 |
<hr />
|
|
|
2384 |
</div>
|
|
|
2385 |
</div>
|
|
|
2386 |
</div>
|
|
|
2387 |
|
|
|
2388 |
|
|
|
2389 |
</div>
|
|
|
2390 |
|
|
|
2391 |
<div rel="yui:attributes" resource="#configattributes">
|
|
|
2392 |
|
|
|
2393 |
</div>
|
|
|
2394 |
|
|
|
2395 |
</div>
|
|
|
2396 |
</div>
|
|
|
2397 |
<div class="yui-b">
|
|
|
2398 |
<div class="nav">
|
|
|
2399 |
|
|
|
2400 |
<div id="moduleList" class="module">
|
|
|
2401 |
<h4>Modules</h4>
|
|
|
2402 |
<ul class="content">
|
|
|
2403 |
<li class=""><a href="module_anim.html" title="anim">anim</a></li>
|
|
|
2404 |
<li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
|
|
|
2405 |
<li class=""><a href="module_base.html" title="base">base</a></li>
|
|
|
2406 |
<li class=""><a href="module_cache.html" title="cache">cache</a></li>
|
|
|
2407 |
<li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
|
|
|
2408 |
<li class=""><a href="module_collection.html" title="collection">collection</a></li>
|
|
|
2409 |
<li class=""><a href="module_console.html" title="console">console</a></li>
|
|
|
2410 |
<li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
|
|
|
2411 |
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
|
|
|
2412 |
<li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
|
|
|
2413 |
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
|
|
|
2414 |
<li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
|
|
|
2415 |
<li class=""><a href="module_dd.html" title="dd">dd</a></li>
|
|
|
2416 |
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
|
|
|
2417 |
<li class=""><a href="module_dump.html" title="dump">dump</a></li>
|
|
|
2418 |
<li class=""><a href="module_event.html" title="event">event</a></li>
|
|
|
2419 |
<li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
|
|
|
2420 |
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
|
|
|
2421 |
<li class=""><a href="module_history.html" title="history">history</a></li>
|
|
|
2422 |
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
|
|
|
2423 |
<li class="selected"><a href="module_io.html" title="io">io</a></li>
|
|
|
2424 |
<li class=""><a href="module_json.html" title="json">json</a></li>
|
|
|
2425 |
<li class=""><a href="module_node.html" title="node">node</a></li>
|
|
|
2426 |
<li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
|
|
|
2427 |
<li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
|
|
|
2428 |
<li class=""><a href="module_oop.html" title="oop">oop</a></li>
|
|
|
2429 |
<li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
|
|
|
2430 |
<li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
|
|
|
2431 |
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
|
|
|
2432 |
<li class=""><a href="module_queue.html" title="queue">queue</a></li>
|
|
|
2433 |
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
|
|
|
2434 |
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
|
|
|
2435 |
<li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
|
|
|
2436 |
<li class=""><a href="module_test.html" title="test">test</a></li>
|
|
|
2437 |
<li class=""><a href="module_widget.html" title="widget">widget</a></li>
|
|
|
2438 |
<li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
|
|
|
2439 |
<li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li>
|
|
|
2440 |
<li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
|
|
|
2441 |
<li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
|
|
|
2442 |
<li class=""><a href="module_yui.html" title="yui">yui</a></li>
|
|
|
2443 |
</ul>
|
|
|
2444 |
</div>
|
|
|
2445 |
|
|
|
2446 |
<div id="classList" class="module">
|
|
|
2447 |
<h4>Classes</h4>
|
|
|
2448 |
<ul class="content">
|
|
|
2449 |
<li class="selected"><a href="io.html" title="io">io</a></li>
|
|
|
2450 |
</ul>
|
|
|
2451 |
</div>
|
|
|
2452 |
|
|
|
2453 |
<div id="fileList" class="module">
|
|
|
2454 |
<h4>Files</h4>
|
|
|
2455 |
<ul class="content">
|
|
|
2456 |
<li class=""><a href="io-base.js.html" title="io-base.js">io-base.js</a></li>
|
|
|
2457 |
<li class=""><a href="io-form.js.html" title="io-form.js">io-form.js</a></li>
|
|
|
2458 |
<li class=""><a href="io-queue.js.html" title="io-queue.js">io-queue.js</a></li>
|
|
|
2459 |
<li class=""><a href="io-upload-iframe.js.html" title="io-upload-iframe.js">io-upload-iframe.js</a></li>
|
|
|
2460 |
<li class=""><a href="io-xdr.js.html" title="io-xdr.js">io-xdr.js</a></li>
|
|
|
2461 |
</ul>
|
|
|
2462 |
</div>
|
|
|
2463 |
|
|
|
2464 |
<div id="propertyList" class="module">
|
|
|
2465 |
<h4>Properties</h4>
|
|
|
2466 |
<ul class="content">
|
|
|
2467 |
<li class="private"><a href="#property__e" title="_e">_e</a></li>
|
|
|
2468 |
<li class="private"><a href="#property__fn" title="_fn">_fn</a></li>
|
|
|
2469 |
<li class="private"><a href="#property__headers" title="_headers">_headers</a></li>
|
|
|
2470 |
<li class="private"><a href="#property__qState" title="_qState">_qState</a></li>
|
|
|
2471 |
<li class="private"><a href="#property__timeOut" title="_timeOut">_timeOut</a></li>
|
|
|
2472 |
<li class="private"><a href="#property__transport" title="_transport">_transport</a></li>
|
|
|
2473 |
<li class="private"><a href="#property__yQ" title="_yQ">_yQ</a></li>
|
|
|
2474 |
<li class="private"><a href="#property_transactionId" title="transactionId">transactionId</a></li>
|
|
|
2475 |
</ul>
|
|
|
2476 |
</div>
|
|
|
2477 |
|
|
|
2478 |
<div id="methodsList" class="module">
|
|
|
2479 |
<h4>Methods</h4>
|
|
|
2480 |
<ul class="content">
|
|
|
2481 |
<li class="private"><a href="#method__async" title="_async">_async</a></li>
|
|
|
2482 |
<li class="private"><a href="#method__clearTimeout" title="_clearTimeout">_clearTimeout</a></li>
|
|
|
2483 |
<li class="private"><a href="#method__concat" title="_concat">_concat</a></li>
|
|
|
2484 |
<li class="private"><a href="#method__create" title="_create">_create</a></li>
|
|
|
2485 |
<li class="private"><a href="#method__handleResponse" title="_handleResponse">_handleResponse</a></li>
|
|
|
2486 |
<li class="private"><a href="#method__id" title="_id">_id</a></li>
|
|
|
2487 |
<li class="private"><a href="#method__io" title="_io">_io</a></li>
|
|
|
2488 |
<li class="private"><a href="#method__ioCancel" title="_ioCancel">_ioCancel</a></li>
|
|
|
2489 |
<li class="private"><a href="#method__ioComplete" title="_ioComplete">_ioComplete</a></li>
|
|
|
2490 |
<li class="private"><a href="#method__ioEnd" title="_ioEnd">_ioEnd</a></li>
|
|
|
2491 |
<li class="private"><a href="#method__ioFailure" title="_ioFailure">_ioFailure</a></li>
|
|
|
2492 |
<li class="private"><a href="#method__ioStart" title="_ioStart">_ioStart</a></li>
|
|
|
2493 |
<li class="private"><a href="#method__ioSuccess" title="_ioSuccess">_ioSuccess</a></li>
|
|
|
2494 |
<li class="private"><a href="#method__isInProgress" title="_isInProgress">_isInProgress</a></li>
|
|
|
2495 |
<li class="private"><a href="#method__queue" title="_queue">_queue</a></li>
|
|
|
2496 |
<li class="private"><a href="#method__readyState" title="_readyState">_readyState</a></li>
|
|
|
2497 |
<li class="private"><a href="#method__remove" title="_remove">_remove</a></li>
|
|
|
2498 |
<li class="private"><a href="#method__serialize" title="_serialize">_serialize</a></li>
|
|
|
2499 |
<li class="private"><a href="#method__setHeader" title="_setHeader">_setHeader</a></li>
|
|
|
2500 |
<li class="private"><a href="#method__setHeaders" title="_setHeaders">_setHeaders</a></li>
|
|
|
2501 |
<li class="private"><a href="#method__shift" title="_shift">_shift</a></li>
|
|
|
2502 |
<li class="private"><a href="#method__size" title="_size">_size</a></li>
|
|
|
2503 |
<li class="private"><a href="#method__startTimeout" title="_startTimeout">_startTimeout</a></li>
|
|
|
2504 |
<li class="private"><a href="#method__stop" title="_stop">_stop</a></li>
|
|
|
2505 |
<li class="private"><a href="#method__swf" title="_swf">_swf</a></li>
|
|
|
2506 |
<li class="private"><a href="#method__tPubSub" title="_tPubSub">_tPubSub</a></li>
|
|
|
2507 |
<li class="private"><a href="#method__unshift" title="_unshift">_unshift</a></li>
|
|
|
2508 |
<li class="private"><a href="#method__upload" title="_upload">_upload</a></li>
|
|
|
2509 |
<li class="private"><a href="#method__xdr" title="_xdr">_xdr</a></li>
|
|
|
2510 |
<li class="private"><a href="#method__xhr" title="_xhr">_xhr</a></li>
|
|
|
2511 |
<li class="private"><a href="#method_appendData" title="appendData">appendData</a></li>
|
|
|
2512 |
<li class=""><a href="#method_header" title="header">header</a></li>
|
|
|
2513 |
<li class=""><a href="#method_io" title="io">io</a></li>
|
|
|
2514 |
<li class=""><a href="#method_promote" title="promote">promote</a></li>
|
|
|
2515 |
<li class=""><a href="#method_purge" title="purge">purge</a></li>
|
|
|
2516 |
<li class=""><a href="#method_size" title="size">size</a></li>
|
|
|
2517 |
<li class=""><a href="#method_start" title="start">start</a></li>
|
|
|
2518 |
<li class=""><a href="#method_stop" title="stop">stop</a></li>
|
|
|
2519 |
<li class=""><a href="#method_transport" title="transport">transport</a></li>
|
|
|
2520 |
<li class="private"><a href="#method_xdrReady" title="xdrReady">xdrReady</a></li>
|
|
|
2521 |
</ul>
|
|
|
2522 |
</div>
|
|
|
2523 |
|
|
|
2524 |
<div id="eventsList" class="module">
|
|
|
2525 |
<h4>Events</h4>
|
|
|
2526 |
<ul class="content">
|
|
|
2527 |
<li class=""><a href="#event_io:complete" title="io:complete">io:complete</a></li>
|
|
|
2528 |
<li class=""><a href="#event_io:end" title="io:end">io:end</a></li>
|
|
|
2529 |
<li class=""><a href="#event_io:failure" title="io:failure">io:failure</a></li>
|
|
|
2530 |
<li class=""><a href="#event_io:start" title="io:start">io:start</a></li>
|
|
|
2531 |
<li class=""><a href="#event_io:success" title="io:success">io:success</a></li>
|
|
|
2532 |
<li class=""><a href="#event_io:xdrReady" title="io:xdrReady">io:xdrReady</a></li>
|
|
|
2533 |
</ul>
|
|
|
2534 |
</div>
|
|
|
2535 |
|
|
|
2536 |
|
|
|
2537 |
</div>
|
|
|
2538 |
</div>
|
|
|
2539 |
</div>
|
|
|
2540 |
<div id="ft">
|
|
|
2541 |
<hr />
|
|
|
2542 |
Copyright © 2009 Yahoo! Inc. All rights reserved.
|
|
|
2543 |
</div>
|
|
|
2544 |
</div>
|
|
|
2545 |
<script type="text/javascript">
|
|
|
2546 |
ALL_YUI_PROPS = [{"access": "private", "host": "io", "name": "appendData", "url": "io.html#method_appendData", "type": "method"}, {"access": "private", "host": "io", "name": "_async", "url": "io.html#method__async", "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": "_e", "url": "io.html#property__e", "type": "property"}, {"access": "private", "host": "io", "name": "_fn", "url": "io.html#property__fn", "type": "property"}, {"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": "", "host": "io", "name": "purge", "url": "io.html#method_purge", "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": "private", "host": "io", "name": "_serialize", "url": "io.html#method__serialize", "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": "_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": "_tPubSub", "url": "io.html#method__tPubSub", "type": "method"}, {"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": "_xhr", "url": "io.html#method__xhr", "type": "method"}, {"access": "private", "host": "io", "name": "_yQ", "url": "io.html#property__yQ", "type": "property"}];
|
|
|
2547 |
</script>
|
|
|
2548 |
</body>
|
|
|
2549 |
</html>
|