|
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.0</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__rS"> |
|
139 <h4><a name="property__rS" property="yui:name">_rS</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 Map of transaction state used when XDomainRequest is the |
|
145 XDR transport. |
|
146 </div> |
|
147 </div> |
|
148 |
|
149 |
|
150 |
|
151 |
|
152 <hr /> |
|
153 </div> |
|
154 <div class="private" rel="yui:property" resource="#property__timeout"> |
|
155 <h4><a name="property__timeout" property="yui:name">_timeout</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 Object that stores timeout values for any transaction with |
|
161 a defined "timeout" configuration property. |
|
162 </div> |
|
163 </div> |
|
164 |
|
165 |
|
166 |
|
167 |
|
168 <hr /> |
|
169 </div> |
|
170 <div class="private" rel="yui:property" resource="#property__transport"> |
|
171 <h4><a name="property__transport" property="yui:name">_transport</a> |
|
172 - <code>private static <span property="yui:type">object</span></code> |
|
173 </h4> |
|
174 <div class="detail"> |
|
175 <div class="description" property="yui:description"> |
|
176 Map of io transports. |
|
177 </div> |
|
178 </div> |
|
179 |
|
180 |
|
181 |
|
182 |
|
183 <hr /> |
|
184 </div> |
|
185 <div class="private" rel="yui:property" resource="#property__yQ"> |
|
186 <h4><a name="property__yQ" property="yui:name">_yQ</a> |
|
187 - <code>private static <span property="yui:type">Object</span></code> |
|
188 </h4> |
|
189 <div class="detail"> |
|
190 <div class="description" property="yui:description"> |
|
191 Array of transactions queued for processing |
|
192 </div> |
|
193 </div> |
|
194 |
|
195 |
|
196 |
|
197 |
|
198 <hr /> |
|
199 </div> |
|
200 <div class="private" rel="yui:property" resource="#property_transactionId"> |
|
201 <h4><a name="property_transactionId" property="yui:name">transactionId</a> |
|
202 - <code>private static <span property="yui:type">int</span></code> |
|
203 </h4> |
|
204 <div class="detail"> |
|
205 <div class="description" property="yui:description"> |
|
206 A transaction counter that increments for each transaction. |
|
207 </div> |
|
208 </div> |
|
209 |
|
210 |
|
211 |
|
212 |
|
213 <hr /> |
|
214 </div> |
|
215 </div> |
|
216 </div> |
|
217 |
|
218 </div> |
|
219 |
|
220 <div rel="yui:methods" resource="#methods"> |
|
221 <div class="section method details"> |
|
222 <h3 id="methods">Methods</h3> |
|
223 <div class="content"> |
|
224 <div class="private" rel="yui:method" resource="#method__abort"> |
|
225 <h4> |
|
226 <a name="method__abort">_abort</a></h4> |
|
227 <div class="detail" > |
|
228 <code> |
|
229 private |
|
230 static |
|
231 |
|
232 void |
|
233 <strong property="yui:name">_abort</strong> |
|
234 ( |
|
235 |
|
236 |
|
237 o |
|
238 |
|
239 |
|
240 , |
|
241 c |
|
242 |
|
243 |
|
244 ) |
|
245 </code> |
|
246 |
|
247 <div class="description" property="yui:description"> |
|
248 Method for intiating an XDR transaction abort. |
|
249 </div> |
|
250 |
|
251 <div class="description"> |
|
252 |
|
253 <dl rel="yui:parameters"> |
|
254 <dt>Parameters:</dt> |
|
255 <dd rel="yui:parameter"> |
|
256 <code><span property="yui:name">o</span> |
|
257 <<span property="yui:type">object</span>> |
|
258 </code> |
|
259 <span property="yui:description"> - Transaction object generated by _create() in io-base.</span> |
|
260 </dd> |
|
261 <dd rel="yui:parameter"> |
|
262 <code><span property="yui:name">c</span> |
|
263 <<span property="yui:type">object</span>> |
|
264 </code> |
|
265 <span property="yui:description"> - configuration object for the transaction.</span> |
|
266 </dd> |
|
267 </dl> |
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 </div> |
|
274 |
|
275 </div> |
|
276 <hr /> |
|
277 </div> |
|
278 <div class="private" rel="yui:method" resource="#method__clearTimeout"> |
|
279 <h4> |
|
280 <a name="method__clearTimeout">_clearTimeout</a></h4> |
|
281 <div class="detail" > |
|
282 <code> |
|
283 private |
|
284 static |
|
285 |
|
286 |
|
287 <strong property="yui:name">_clearTimeout</strong> |
|
288 ( |
|
289 |
|
290 |
|
291 id |
|
292 |
|
293 |
|
294 ) |
|
295 </code> |
|
296 |
|
297 <div class="description" property="yui:description"> |
|
298 Clears the timeout interval started by _startTimeout(). |
|
299 </div> |
|
300 |
|
301 <div class="description"> |
|
302 |
|
303 <dl rel="yui:parameters"> |
|
304 <dt>Parameters:</dt> |
|
305 <dd rel="yui:parameter"> |
|
306 <code><span property="yui:name">id</span> |
|
307 <<span property="yui:type">number</span>> |
|
308 </code> |
|
309 <span property="yui:description"> - Transaction id.</span> |
|
310 </dd> |
|
311 </dl> |
|
312 |
|
313 <dl> |
|
314 <dt>Returns: |
|
315 <code property="yui:return"> |
|
316 </code></dt> |
|
317 <dd property="yui:returnInfo">void</dd> |
|
318 </dl> |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 </div> |
|
324 |
|
325 </div> |
|
326 <hr /> |
|
327 </div> |
|
328 <div class="private" rel="yui:method" resource="#method__concat"> |
|
329 <h4> |
|
330 <a name="method__concat">_concat</a></h4> |
|
331 <div class="detail" > |
|
332 <code> |
|
333 private |
|
334 static |
|
335 |
|
336 |
|
337 <strong property="yui:name">_concat</strong> |
|
338 ( |
|
339 |
|
340 |
|
341 s |
|
342 |
|
343 |
|
344 , |
|
345 d |
|
346 |
|
347 |
|
348 ) |
|
349 </code> |
|
350 |
|
351 <div class="description" property="yui:description"> |
|
352 Method that concatenates string data for HTTP GET transactions. |
|
353 </div> |
|
354 |
|
355 <div class="description"> |
|
356 |
|
357 <dl rel="yui:parameters"> |
|
358 <dt>Parameters:</dt> |
|
359 <dd rel="yui:parameter"> |
|
360 <code><span property="yui:name">s</span> |
|
361 <<span property="yui:type">string</span>> |
|
362 </code> |
|
363 <span property="yui:description"> - URI or root data.</span> |
|
364 </dd> |
|
365 <dd rel="yui:parameter"> |
|
366 <code><span property="yui:name">d</span> |
|
367 <<span property="yui:type">string</span>> |
|
368 </code> |
|
369 <span property="yui:description"> - data to be concatenated onto URI.</span> |
|
370 </dd> |
|
371 </dl> |
|
372 |
|
373 <dl> |
|
374 <dt>Returns: |
|
375 <code property="yui:return"> |
|
376 </code></dt> |
|
377 <dd property="yui:returnInfo">int</dd> |
|
378 </dl> |
|
379 |
|
380 |
|
381 |
|
382 |
|
383 </div> |
|
384 |
|
385 </div> |
|
386 <hr /> |
|
387 </div> |
|
388 <div class="private" rel="yui:method" resource="#method__create"> |
|
389 <h4> |
|
390 <a name="method__create">_create</a></h4> |
|
391 <div class="detail" > |
|
392 <code> |
|
393 private |
|
394 static |
|
395 |
|
396 |
|
397 <strong property="yui:name">_create</strong> |
|
398 ( |
|
399 |
|
400 |
|
401 c |
|
402 |
|
403 |
|
404 , |
|
405 i |
|
406 |
|
407 |
|
408 ) |
|
409 </code> |
|
410 |
|
411 <div class="description" property="yui:description"> |
|
412 Method that creates a unique transaction object for each |
|
413 request. |
|
414 </div> |
|
415 |
|
416 <div class="description"> |
|
417 |
|
418 <dl rel="yui:parameters"> |
|
419 <dt>Parameters:</dt> |
|
420 <dd rel="yui:parameter"> |
|
421 <code><span property="yui:name">c</span> |
|
422 <<span property="yui:type">number</span>> |
|
423 </code> |
|
424 <span property="yui:description"> - configuration object subset to determine if |
|
425 the transaction is an XDR or file upload, |
|
426 requiring an alternate transport.</span> |
|
427 </dd> |
|
428 <dd rel="yui:parameter"> |
|
429 <code><span property="yui:name">i</span> |
|
430 <<span property="yui:type">number</span>> |
|
431 </code> |
|
432 <span property="yui:description"> - transaction id</span> |
|
433 </dd> |
|
434 </dl> |
|
435 |
|
436 <dl> |
|
437 <dt>Returns: |
|
438 <code property="yui:return"> |
|
439 </code></dt> |
|
440 <dd property="yui:returnInfo">object</dd> |
|
441 </dl> |
|
442 |
|
443 |
|
444 |
|
445 |
|
446 </div> |
|
447 |
|
448 </div> |
|
449 <hr /> |
|
450 </div> |
|
451 <div class="private" rel="yui:method" resource="#method__data"> |
|
452 <h4> |
|
453 <a name="method__data">_data</a></h4> |
|
454 <div class="detail" > |
|
455 <code> |
|
456 private |
|
457 static |
|
458 |
|
459 |
|
460 <strong property="yui:name">_data</strong> |
|
461 ( |
|
462 |
|
463 |
|
464 o |
|
465 |
|
466 |
|
467 , |
|
468 isFlash |
|
469 |
|
470 |
|
471 , |
|
472 isXML |
|
473 |
|
474 |
|
475 ) |
|
476 </code> |
|
477 |
|
478 <div class="description" property="yui:description"> |
|
479 Creates a response object for XDR transactions, for success |
|
480 and failure cases. |
|
481 </div> |
|
482 |
|
483 <div class="description"> |
|
484 |
|
485 <dl rel="yui:parameters"> |
|
486 <dt>Parameters:</dt> |
|
487 <dd rel="yui:parameter"> |
|
488 <code><span property="yui:name">o</span> |
|
489 <<span property="yui:type">object</span>> |
|
490 </code> |
|
491 <span property="yui:description"> - Transaction object generated by _create() in io-base.</span> |
|
492 </dd> |
|
493 <dd rel="yui:parameter"> |
|
494 <code><span property="yui:name">isFlash</span> |
|
495 <<span property="yui:type">boolean</span>> |
|
496 </code> |
|
497 <span property="yui:description"> - True if Flash was used as the transport.</span> |
|
498 </dd> |
|
499 <dd rel="yui:parameter"> |
|
500 <code><span property="yui:name">isXML</span> |
|
501 <<span property="yui:type">boolean</span>> |
|
502 </code> |
|
503 <span property="yui:description"> - True if the response data are XML.</span> |
|
504 </dd> |
|
505 </dl> |
|
506 |
|
507 <dl> |
|
508 <dt>Returns: |
|
509 <code property="yui:return"> |
|
510 </code></dt> |
|
511 <dd property="yui:returnInfo">object</dd> |
|
512 </dl> |
|
513 |
|
514 |
|
515 |
|
516 |
|
517 </div> |
|
518 |
|
519 </div> |
|
520 <hr /> |
|
521 </div> |
|
522 <div class="private" rel="yui:method" resource="#method__destroy"> |
|
523 <h4> |
|
524 <a name="method__destroy">_destroy</a></h4> |
|
525 <div class="detail" > |
|
526 <code> |
|
527 private |
|
528 static |
|
529 |
|
530 void |
|
531 <strong property="yui:name">_destroy</strong> |
|
532 ( |
|
533 |
|
534 |
|
535 o |
|
536 |
|
537 |
|
538 , |
|
539 uri |
|
540 |
|
541 |
|
542 , |
|
543 c |
|
544 |
|
545 |
|
546 ) |
|
547 </code> |
|
548 |
|
549 <div class="description" property="yui:description"> |
|
550 |
|
551 </div> |
|
552 |
|
553 <div class="description"> |
|
554 |
|
555 <dl rel="yui:parameters"> |
|
556 <dt>Parameters:</dt> |
|
557 <dd rel="yui:parameter"> |
|
558 <code><span property="yui:name">o</span> |
|
559 <<span property="yui:type">o</span>> |
|
560 </code> |
|
561 <span property="yui:description"> The transaction object</span> |
|
562 </dd> |
|
563 <dd rel="yui:parameter"> |
|
564 <code><span property="yui:name">uri</span> |
|
565 <<span property="yui:type">object</span>> |
|
566 </code> |
|
567 <span property="yui:description"> Qualified path to transaction resource.</span> |
|
568 </dd> |
|
569 <dd rel="yui:parameter"> |
|
570 <code><span property="yui:name">c</span> |
|
571 <<span property="yui:type">object</span>> |
|
572 </code> |
|
573 <span property="yui:description"> Configuration object for the transaction.</span> |
|
574 </dd> |
|
575 </dl> |
|
576 |
|
577 |
|
578 |
|
579 |
|
580 |
|
581 </div> |
|
582 |
|
583 </div> |
|
584 <hr /> |
|
585 </div> |
|
586 <div class="private" rel="yui:method" resource="#method__handle"> |
|
587 <h4> |
|
588 <a name="method__handle">_handle</a></h4> |
|
589 <div class="detail" > |
|
590 <code> |
|
591 private |
|
592 static |
|
593 |
|
594 void |
|
595 <strong property="yui:name">_handle</strong> |
|
596 ( |
|
597 |
|
598 |
|
599 o |
|
600 |
|
601 |
|
602 , |
|
603 c |
|
604 |
|
605 |
|
606 ) |
|
607 </code> |
|
608 |
|
609 <div class="description" property="yui:description"> |
|
610 Bound to the iframe's Load event and processes |
|
611 the response data. |
|
612 </div> |
|
613 |
|
614 <div class="description"> |
|
615 |
|
616 <dl rel="yui:parameters"> |
|
617 <dt>Parameters:</dt> |
|
618 <dd rel="yui:parameter"> |
|
619 <code><span property="yui:name">o</span> |
|
620 <<span property="yui:type">o</span>> |
|
621 </code> |
|
622 <span property="yui:description"> The transaction object</span> |
|
623 </dd> |
|
624 <dd rel="yui:parameter"> |
|
625 <code><span property="yui:name">c</span> |
|
626 <<span property="yui:type">object</span>> |
|
627 </code> |
|
628 <span property="yui:description"> Configuration object for the transaction.</span> |
|
629 </dd> |
|
630 </dl> |
|
631 |
|
632 |
|
633 |
|
634 |
|
635 |
|
636 </div> |
|
637 |
|
638 </div> |
|
639 <hr /> |
|
640 </div> |
|
641 <div class="private" rel="yui:method" resource="#method__handleResponse"> |
|
642 <h4> |
|
643 <a name="method__handleResponse">_handleResponse</a></h4> |
|
644 <div class="detail" > |
|
645 <code> |
|
646 private |
|
647 static |
|
648 |
|
649 |
|
650 <strong property="yui:name">_handleResponse</strong> |
|
651 ( |
|
652 |
|
653 |
|
654 o |
|
655 |
|
656 |
|
657 , |
|
658 c |
|
659 |
|
660 |
|
661 ) |
|
662 </code> |
|
663 |
|
664 <div class="description" property="yui:description"> |
|
665 Method that determines if a transaction response qualifies |
|
666 as success or failure, based on the response HTTP status code, and |
|
667 fires the appropriate success or failure events. |
|
668 </div> |
|
669 |
|
670 <div class="description"> |
|
671 |
|
672 <dl rel="yui:parameters"> |
|
673 <dt>Parameters:</dt> |
|
674 <dd rel="yui:parameter"> |
|
675 <code><span property="yui:name">o</span> |
|
676 <<span property="yui:type">object</span>> |
|
677 </code> |
|
678 <span property="yui:description"> - Transaction object generated by _create().</span> |
|
679 </dd> |
|
680 <dd rel="yui:parameter"> |
|
681 <code><span property="yui:name">c</span> |
|
682 <<span property="yui:type">object</span>> |
|
683 </code> |
|
684 <span property="yui:description"> - Configuration object passed to io().</span> |
|
685 </dd> |
|
686 </dl> |
|
687 |
|
688 <dl> |
|
689 <dt>Returns: |
|
690 <code property="yui:return"> |
|
691 </code></dt> |
|
692 <dd property="yui:returnInfo">void</dd> |
|
693 </dl> |
|
694 |
|
695 |
|
696 |
|
697 |
|
698 </div> |
|
699 |
|
700 </div> |
|
701 <hr /> |
|
702 </div> |
|
703 <div class="private" rel="yui:method" resource="#method__id"> |
|
704 <h4> |
|
705 <a name="method__id">_id</a></h4> |
|
706 <div class="detail" > |
|
707 <code> |
|
708 private |
|
709 static |
|
710 |
|
711 |
|
712 <strong property="yui:name">_id</strong> |
|
713 ( |
|
714 ) |
|
715 </code> |
|
716 |
|
717 <div class="description" property="yui:description"> |
|
718 Method that increments _transactionId for each transaction. |
|
719 </div> |
|
720 |
|
721 <div class="description"> |
|
722 |
|
723 |
|
724 <dl> |
|
725 <dt>Returns: |
|
726 <code property="yui:return"> |
|
727 </code></dt> |
|
728 <dd property="yui:returnInfo">int</dd> |
|
729 </dl> |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 </div> |
|
735 |
|
736 </div> |
|
737 <hr /> |
|
738 </div> |
|
739 <div class="private" rel="yui:method" resource="#method__io"> |
|
740 <h4> |
|
741 <a name="method__io">_io</a></h4> |
|
742 <div class="detail" > |
|
743 <code> |
|
744 private |
|
745 static |
|
746 |
|
747 |
|
748 <strong property="yui:name">_io</strong> |
|
749 ( |
|
750 |
|
751 |
|
752 uri |
|
753 |
|
754 |
|
755 , |
|
756 c |
|
757 |
|
758 |
|
759 , |
|
760 i |
|
761 |
|
762 |
|
763 ) |
|
764 </code> |
|
765 |
|
766 <div class="description" property="yui:description"> |
|
767 Method for requesting a transaction. _io() is implemented as |
|
768 yui.io(). Each transaction may include a configuration object. Its |
|
769 properties are: |
|
770 method: HTTP method verb (e.g., GET or POST). If this property is not |
|
771 not defined, the default value will be GET. |
|
772 data: This is the name-value string that will be sent as the transaction |
|
773 data. If the request is HTTP GET, the data become part of |
|
774 querystring. If HTTP POST, the data are sent in the message body. |
|
775 xdr: Defines the transport to be used for cross-domain requests. By |
|
776 setting this property, the transaction will use the specified |
|
777 transport instead of XMLHttpRequest. Currently, the only alternate |
|
778 transport supported is Flash (e.g., { xdr: 'flash' }). |
|
779 form: This is a defined object used to process HTML form as data. The |
|
780 properties are: |
|
781 { |
|
782 id: object, //HTML form object or id of HTML form |
|
783 useDisabled: boolean, //Allow disabled HTML form field values |
|
784 to be sent as part of the data. |
|
785 } |
|
786 on: This is a defined object used to create and handle specific |
|
787 events during a transaction lifecycle. These events will fire in |
|
788 addition to the global io events. The events are: |
|
789 start - This event is fired when a request is sent to a resource. |
|
790 complete - This event fires when the transaction is complete. |
|
791 success - This event fires when the response status resolves to |
|
792 HTTP 2xx. |
|
793 failure - This event fires when the response status resolves to |
|
794 HTTP 4xx, 5xx; and, for all transaction exceptions, |
|
795 including aborted transactions and transaction timeouts. |
|
796 end - This even is fired at the conclusion of the transaction |
|
797 lifecycle, after a success or failure resolution. |
|
798 The properties are: |
|
799 { |
|
800 start: function(id, args){}, |
|
801 complete: function(id, responseobject, args){}, |
|
802 success: function(id, responseobject, args){}, |
|
803 failure: function(id, responseobject, args){}, |
|
804 end: function(id, args){} |
|
805 } |
|
806 Each property can reference a function or be written as an |
|
807 inline function. |
|
808 context: Object reference for an event handler when it is implemented |
|
809 as a method of a base object. Defining "context" will preserve |
|
810 the proper reference of "this" used in the event handler. |
|
811 headers: This is a defined object of client headers, as many as. |
|
812 desired for the transaction. These headers are sentThe object |
|
813 pattern is: |
|
814 { |
|
815 header: value |
|
816 } |
|
817 timeout: This value, defined as milliseconds, is a time threshold for the |
|
818 transaction. When this threshold is reached, and the transaction's |
|
819 Complete event has not yet fired, the transaction will be aborted. |
|
820 arguments: Object, array, string, or number passed to all registered |
|
821 event handlers. This value is available as the second |
|
822 argument in the "start" and "abort" event handlers; and, it is |
|
823 the third argument in the "complete", "success", and "failure" |
|
824 event handlers. |
|
825 </div> |
|
826 |
|
827 <div class="description"> |
|
828 |
|
829 <dl rel="yui:parameters"> |
|
830 <dt>Parameters:</dt> |
|
831 <dd rel="yui:parameter"> |
|
832 <code><span property="yui:name">uri</span> |
|
833 <<span property="yui:type">string</span>> |
|
834 </code> |
|
835 <span property="yui:description"> - qualified path to transaction resource.</span> |
|
836 </dd> |
|
837 <dd rel="yui:parameter"> |
|
838 <code><span property="yui:name">c</span> |
|
839 <<span property="yui:type">object</span>> |
|
840 </code> |
|
841 <span property="yui:description"> - configuration object for the transaction.</span> |
|
842 </dd> |
|
843 <dd rel="yui:parameter"> |
|
844 <code><span property="yui:name">i</span> |
|
845 <<span property="yui:type">number</span>> |
|
846 </code> |
|
847 <span property="yui:description"> - transaction id, if already set by queue.</span> |
|
848 </dd> |
|
849 </dl> |
|
850 |
|
851 <dl> |
|
852 <dt>Returns: |
|
853 <code property="yui:return"> |
|
854 </code></dt> |
|
855 <dd property="yui:returnInfo">object</dd> |
|
856 </dl> |
|
857 |
|
858 |
|
859 |
|
860 |
|
861 </div> |
|
862 |
|
863 </div> |
|
864 <hr /> |
|
865 </div> |
|
866 <div class="private" rel="yui:method" resource="#method__ioCancel"> |
|
867 <h4> |
|
868 <a name="method__ioCancel">_ioCancel</a></h4> |
|
869 <div class="detail" > |
|
870 <code> |
|
871 private |
|
872 static |
|
873 |
|
874 |
|
875 <strong property="yui:name">_ioCancel</strong> |
|
876 ( |
|
877 |
|
878 |
|
879 o |
|
880 |
|
881 |
|
882 , |
|
883 s |
|
884 |
|
885 |
|
886 ) |
|
887 </code> |
|
888 |
|
889 <div class="description" property="yui:description"> |
|
890 Terminates a transaction due to an explicit abort or |
|
891 timeout. |
|
892 </div> |
|
893 |
|
894 <div class="description"> |
|
895 |
|
896 <dl rel="yui:parameters"> |
|
897 <dt>Parameters:</dt> |
|
898 <dd rel="yui:parameter"> |
|
899 <code><span property="yui:name">o</span> |
|
900 <<span property="yui:type">object</span>> |
|
901 </code> |
|
902 <span property="yui:description"> - Transaction object generated by _create().</span> |
|
903 </dd> |
|
904 <dd rel="yui:parameter"> |
|
905 <code><span property="yui:name">s</span> |
|
906 <<span property="yui:type">string</span>> |
|
907 </code> |
|
908 <span property="yui:description"> - Identifies timed out or aborted transaction.</span> |
|
909 </dd> |
|
910 </dl> |
|
911 |
|
912 <dl> |
|
913 <dt>Returns: |
|
914 <code property="yui:return"> |
|
915 </code></dt> |
|
916 <dd property="yui:returnInfo">void</dd> |
|
917 </dl> |
|
918 |
|
919 |
|
920 |
|
921 |
|
922 </div> |
|
923 |
|
924 </div> |
|
925 <hr /> |
|
926 </div> |
|
927 <div class="private" rel="yui:method" resource="#method__ioComplete"> |
|
928 <h4> |
|
929 <a name="method__ioComplete">_ioComplete</a></h4> |
|
930 <div class="detail" > |
|
931 <code> |
|
932 private |
|
933 static |
|
934 |
|
935 |
|
936 <strong property="yui:name">_ioComplete</strong> |
|
937 ( |
|
938 |
|
939 |
|
940 o |
|
941 |
|
942 |
|
943 , |
|
944 c |
|
945 |
|
946 |
|
947 ) |
|
948 </code> |
|
949 |
|
950 <div class="description" property="yui:description"> |
|
951 Fires event "io:complete" and creates, fires a |
|
952 transaction-specific "complete" event, if config.on.complete is |
|
953 defined. |
|
954 </div> |
|
955 |
|
956 <div class="description"> |
|
957 |
|
958 <dl rel="yui:parameters"> |
|
959 <dt>Parameters:</dt> |
|
960 <dd rel="yui:parameter"> |
|
961 <code><span property="yui:name">o</span> |
|
962 <<span property="yui:type">object</span>> |
|
963 </code> |
|
964 <span property="yui:description"> - transaction object.</span> |
|
965 </dd> |
|
966 <dd rel="yui:parameter"> |
|
967 <code><span property="yui:name">c</span> |
|
968 <<span property="yui:type">object</span>> |
|
969 </code> |
|
970 <span property="yui:description"> - configuration object for the transaction.</span> |
|
971 </dd> |
|
972 </dl> |
|
973 |
|
974 <dl> |
|
975 <dt>Returns: |
|
976 <code property="yui:return"> |
|
977 </code></dt> |
|
978 <dd property="yui:returnInfo">void</dd> |
|
979 </dl> |
|
980 |
|
981 |
|
982 |
|
983 |
|
984 </div> |
|
985 |
|
986 </div> |
|
987 <hr /> |
|
988 </div> |
|
989 <div class="private" rel="yui:method" resource="#method__ioEnd"> |
|
990 <h4> |
|
991 <a name="method__ioEnd">_ioEnd</a></h4> |
|
992 <div class="detail" > |
|
993 <code> |
|
994 private |
|
995 static |
|
996 |
|
997 |
|
998 <strong property="yui:name">_ioEnd</strong> |
|
999 ( |
|
1000 |
|
1001 |
|
1002 o |
|
1003 |
|
1004 |
|
1005 , |
|
1006 c |
|
1007 |
|
1008 |
|
1009 ) |
|
1010 </code> |
|
1011 |
|
1012 <div class="description" property="yui:description"> |
|
1013 Fires event "io:end" and creates, fires a |
|
1014 transaction-specific "end" event, if config.on.end is |
|
1015 defined. |
|
1016 </div> |
|
1017 |
|
1018 <div class="description"> |
|
1019 |
|
1020 <dl rel="yui:parameters"> |
|
1021 <dt>Parameters:</dt> |
|
1022 <dd rel="yui:parameter"> |
|
1023 <code><span property="yui:name">o</span> |
|
1024 <<span property="yui:type">object</span>> |
|
1025 </code> |
|
1026 <span property="yui:description"> - transaction object.</span> |
|
1027 </dd> |
|
1028 <dd rel="yui:parameter"> |
|
1029 <code><span property="yui:name">c</span> |
|
1030 <<span property="yui:type">object</span>> |
|
1031 </code> |
|
1032 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1033 </dd> |
|
1034 </dl> |
|
1035 |
|
1036 <dl> |
|
1037 <dt>Returns: |
|
1038 <code property="yui:return"> |
|
1039 </code></dt> |
|
1040 <dd property="yui:returnInfo">void</dd> |
|
1041 </dl> |
|
1042 |
|
1043 |
|
1044 |
|
1045 |
|
1046 </div> |
|
1047 |
|
1048 </div> |
|
1049 <hr /> |
|
1050 </div> |
|
1051 <div class="private" rel="yui:method" resource="#method__ioFailure"> |
|
1052 <h4> |
|
1053 <a name="method__ioFailure">_ioFailure</a></h4> |
|
1054 <div class="detail" > |
|
1055 <code> |
|
1056 private |
|
1057 static |
|
1058 |
|
1059 |
|
1060 <strong property="yui:name">_ioFailure</strong> |
|
1061 ( |
|
1062 |
|
1063 |
|
1064 o |
|
1065 |
|
1066 |
|
1067 , |
|
1068 c |
|
1069 |
|
1070 |
|
1071 ) |
|
1072 </code> |
|
1073 |
|
1074 <div class="description" property="yui:description"> |
|
1075 Fires event "io:failure" and creates, fires a |
|
1076 transaction-specific "failure" event, if config.on.failure is |
|
1077 defined. |
|
1078 </div> |
|
1079 |
|
1080 <div class="description"> |
|
1081 |
|
1082 <dl rel="yui:parameters"> |
|
1083 <dt>Parameters:</dt> |
|
1084 <dd rel="yui:parameter"> |
|
1085 <code><span property="yui:name">o</span> |
|
1086 <<span property="yui:type">object</span>> |
|
1087 </code> |
|
1088 <span property="yui:description"> - transaction object.</span> |
|
1089 </dd> |
|
1090 <dd rel="yui:parameter"> |
|
1091 <code><span property="yui:name">c</span> |
|
1092 <<span property="yui:type">object</span>> |
|
1093 </code> |
|
1094 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1095 </dd> |
|
1096 </dl> |
|
1097 |
|
1098 <dl> |
|
1099 <dt>Returns: |
|
1100 <code property="yui:return"> |
|
1101 </code></dt> |
|
1102 <dd property="yui:returnInfo">void</dd> |
|
1103 </dl> |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 </div> |
|
1109 |
|
1110 </div> |
|
1111 <hr /> |
|
1112 </div> |
|
1113 <div class="private" rel="yui:method" resource="#method__ioStart"> |
|
1114 <h4> |
|
1115 <a name="method__ioStart">_ioStart</a></h4> |
|
1116 <div class="detail" > |
|
1117 <code> |
|
1118 private |
|
1119 static |
|
1120 |
|
1121 |
|
1122 <strong property="yui:name">_ioStart</strong> |
|
1123 ( |
|
1124 |
|
1125 |
|
1126 id |
|
1127 |
|
1128 |
|
1129 , |
|
1130 c |
|
1131 |
|
1132 |
|
1133 ) |
|
1134 </code> |
|
1135 |
|
1136 <div class="description" property="yui:description"> |
|
1137 Fires event "io:start" and creates, fires a |
|
1138 transaction-specific start event, if config.on.start is |
|
1139 defined. |
|
1140 </div> |
|
1141 |
|
1142 <div class="description"> |
|
1143 |
|
1144 <dl rel="yui:parameters"> |
|
1145 <dt>Parameters:</dt> |
|
1146 <dd rel="yui:parameter"> |
|
1147 <code><span property="yui:name">id</span> |
|
1148 <<span property="yui:type">number</span>> |
|
1149 </code> |
|
1150 <span property="yui:description"> - transaction id</span> |
|
1151 </dd> |
|
1152 <dd rel="yui:parameter"> |
|
1153 <code><span property="yui:name">c</span> |
|
1154 <<span property="yui:type">object</span>> |
|
1155 </code> |
|
1156 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1157 </dd> |
|
1158 </dl> |
|
1159 |
|
1160 <dl> |
|
1161 <dt>Returns: |
|
1162 <code property="yui:return"> |
|
1163 </code></dt> |
|
1164 <dd property="yui:returnInfo">void</dd> |
|
1165 </dl> |
|
1166 |
|
1167 |
|
1168 |
|
1169 |
|
1170 </div> |
|
1171 |
|
1172 </div> |
|
1173 <hr /> |
|
1174 </div> |
|
1175 <div class="private" rel="yui:method" resource="#method__ioSuccess"> |
|
1176 <h4> |
|
1177 <a name="method__ioSuccess">_ioSuccess</a></h4> |
|
1178 <div class="detail" > |
|
1179 <code> |
|
1180 private |
|
1181 static |
|
1182 |
|
1183 |
|
1184 <strong property="yui:name">_ioSuccess</strong> |
|
1185 ( |
|
1186 |
|
1187 |
|
1188 o |
|
1189 |
|
1190 |
|
1191 , |
|
1192 c |
|
1193 |
|
1194 |
|
1195 ) |
|
1196 </code> |
|
1197 |
|
1198 <div class="description" property="yui:description"> |
|
1199 Fires event "io:success" and creates, fires a |
|
1200 transaction-specific "success" event, if config.on.success is |
|
1201 defined. |
|
1202 </div> |
|
1203 |
|
1204 <div class="description"> |
|
1205 |
|
1206 <dl rel="yui:parameters"> |
|
1207 <dt>Parameters:</dt> |
|
1208 <dd rel="yui:parameter"> |
|
1209 <code><span property="yui:name">o</span> |
|
1210 <<span property="yui:type">object</span>> |
|
1211 </code> |
|
1212 <span property="yui:description"> - transaction object.</span> |
|
1213 </dd> |
|
1214 <dd rel="yui:parameter"> |
|
1215 <code><span property="yui:name">c</span> |
|
1216 <<span property="yui:type">object</span>> |
|
1217 </code> |
|
1218 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1219 </dd> |
|
1220 </dl> |
|
1221 |
|
1222 <dl> |
|
1223 <dt>Returns: |
|
1224 <code property="yui:return"> |
|
1225 </code></dt> |
|
1226 <dd property="yui:returnInfo">void</dd> |
|
1227 </dl> |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 </div> |
|
1233 |
|
1234 </div> |
|
1235 <hr /> |
|
1236 </div> |
|
1237 <div class="private" rel="yui:method" resource="#method__isInProgress."> |
|
1238 <h4> |
|
1239 <a name="method__isInProgress.">_isInProgress.</a></h4> |
|
1240 <div class="detail" > |
|
1241 <code> |
|
1242 private |
|
1243 static |
|
1244 |
|
1245 void |
|
1246 <strong property="yui:name">_isInProgress.</strong> |
|
1247 ( |
|
1248 |
|
1249 |
|
1250 o |
|
1251 |
|
1252 |
|
1253 , |
|
1254 c |
|
1255 |
|
1256 |
|
1257 ) |
|
1258 </code> |
|
1259 |
|
1260 <div class="description" property="yui:description"> |
|
1261 Method for determining if an XDR transaction has completed |
|
1262 and all data are received. |
|
1263 </div> |
|
1264 |
|
1265 <div class="description"> |
|
1266 |
|
1267 <dl rel="yui:parameters"> |
|
1268 <dt>Parameters:</dt> |
|
1269 <dd rel="yui:parameter"> |
|
1270 <code><span property="yui:name">o</span> |
|
1271 <<span property="yui:type">object</span>> |
|
1272 </code> |
|
1273 <span property="yui:description"> - Transaction object generated by _create() in io-base.</span> |
|
1274 </dd> |
|
1275 <dd rel="yui:parameter"> |
|
1276 <code><span property="yui:name">c</span> |
|
1277 <<span property="yui:type">object</span>> |
|
1278 </code> |
|
1279 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1280 </dd> |
|
1281 </dl> |
|
1282 |
|
1283 |
|
1284 |
|
1285 |
|
1286 |
|
1287 </div> |
|
1288 |
|
1289 </div> |
|
1290 <hr /> |
|
1291 </div> |
|
1292 <div class="private" rel="yui:method" resource="#method__queue"> |
|
1293 <h4> |
|
1294 <a name="method__queue">_queue</a></h4> |
|
1295 <div class="detail" > |
|
1296 <code> |
|
1297 private |
|
1298 static |
|
1299 |
|
1300 |
|
1301 <strong property="yui:name">_queue</strong> |
|
1302 ( |
|
1303 ) |
|
1304 </code> |
|
1305 |
|
1306 <div class="description" property="yui:description"> |
|
1307 Method for requesting a transaction, and queueing the |
|
1308 request before it is sent to the resource. |
|
1309 </div> |
|
1310 |
|
1311 <div class="description"> |
|
1312 |
|
1313 |
|
1314 <dl> |
|
1315 <dt>Returns: |
|
1316 <code property="yui:return"> |
|
1317 </code></dt> |
|
1318 <dd property="yui:returnInfo">Object</dd> |
|
1319 </dl> |
|
1320 |
|
1321 |
|
1322 |
|
1323 |
|
1324 </div> |
|
1325 |
|
1326 </div> |
|
1327 <hr /> |
|
1328 </div> |
|
1329 <div class="private" rel="yui:method" resource="#method__readyState"> |
|
1330 <h4> |
|
1331 <a name="method__readyState">_readyState</a></h4> |
|
1332 <div class="detail" > |
|
1333 <code> |
|
1334 private |
|
1335 static |
|
1336 |
|
1337 |
|
1338 <strong property="yui:name">_readyState</strong> |
|
1339 ( |
|
1340 |
|
1341 |
|
1342 o |
|
1343 |
|
1344 |
|
1345 , |
|
1346 c |
|
1347 |
|
1348 |
|
1349 ) |
|
1350 </code> |
|
1351 |
|
1352 <div class="description" property="yui:description"> |
|
1353 Event handler bound to onreadystatechange. |
|
1354 </div> |
|
1355 |
|
1356 <div class="description"> |
|
1357 |
|
1358 <dl rel="yui:parameters"> |
|
1359 <dt>Parameters:</dt> |
|
1360 <dd rel="yui:parameter"> |
|
1361 <code><span property="yui:name">o</span> |
|
1362 <<span property="yui:type">object</span>> |
|
1363 </code> |
|
1364 <span property="yui:description"> - Transaction object generated by _create().</span> |
|
1365 </dd> |
|
1366 <dd rel="yui:parameter"> |
|
1367 <code><span property="yui:name">c</span> |
|
1368 <<span property="yui:type">object</span>> |
|
1369 </code> |
|
1370 <span property="yui:description"> - Configuration object passed to YUI.io().</span> |
|
1371 </dd> |
|
1372 </dl> |
|
1373 |
|
1374 <dl> |
|
1375 <dt>Returns: |
|
1376 <code property="yui:return"> |
|
1377 </code></dt> |
|
1378 <dd property="yui:returnInfo">void</dd> |
|
1379 </dl> |
|
1380 |
|
1381 |
|
1382 |
|
1383 |
|
1384 </div> |
|
1385 |
|
1386 </div> |
|
1387 <hr /> |
|
1388 </div> |
|
1389 <div class="private" rel="yui:method" resource="#method__remove"> |
|
1390 <h4> |
|
1391 <a name="method__remove">_remove</a></h4> |
|
1392 <div class="detail" > |
|
1393 <code> |
|
1394 private |
|
1395 static |
|
1396 |
|
1397 |
|
1398 <strong property="yui:name">_remove</strong> |
|
1399 ( |
|
1400 ) |
|
1401 </code> |
|
1402 |
|
1403 <div class="description" property="yui:description"> |
|
1404 Method for removing a specific, pending transaction from |
|
1405 the queue. |
|
1406 </div> |
|
1407 |
|
1408 <div class="description"> |
|
1409 |
|
1410 |
|
1411 <dl> |
|
1412 <dt>Returns: |
|
1413 <code property="yui:return"> |
|
1414 </code></dt> |
|
1415 <dd property="yui:returnInfo">void</dd> |
|
1416 </dl> |
|
1417 |
|
1418 |
|
1419 |
|
1420 |
|
1421 </div> |
|
1422 |
|
1423 </div> |
|
1424 <hr /> |
|
1425 </div> |
|
1426 <div class="private" rel="yui:method" resource="#method__resend"> |
|
1427 <h4> |
|
1428 <a name="method__resend">_resend</a></h4> |
|
1429 <div class="detail" > |
|
1430 <code> |
|
1431 private |
|
1432 static |
|
1433 |
|
1434 |
|
1435 <strong property="yui:name">_resend</strong> |
|
1436 ( |
|
1437 |
|
1438 |
|
1439 o |
|
1440 |
|
1441 |
|
1442 , |
|
1443 uri |
|
1444 |
|
1445 |
|
1446 , |
|
1447 c |
|
1448 |
|
1449 |
|
1450 ) |
|
1451 </code> |
|
1452 |
|
1453 <div class="description" property="yui:description"> |
|
1454 Resends an XDR transaction, using the Flash tranport, |
|
1455 if the native transport fails. |
|
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">o</span> |
|
1464 <<span property="yui:type">object</span>> |
|
1465 </code> |
|
1466 <span property="yui:description"> - Transaction object generated by _create().</span> |
|
1467 </dd> |
|
1468 <dd rel="yui:parameter"> |
|
1469 <code><span property="yui:name">uri</span> |
|
1470 <<span property="yui:type">string</span>> |
|
1471 </code> |
|
1472 <span property="yui:description"> - qualified path to transaction resource.</span> |
|
1473 </dd> |
|
1474 <dd rel="yui:parameter"> |
|
1475 <code><span property="yui:name">c</span> |
|
1476 <<span property="yui:type">object</span>> |
|
1477 </code> |
|
1478 <span property="yui:description"> - configuration object for the transaction.</span> |
|
1479 </dd> |
|
1480 </dl> |
|
1481 |
|
1482 <dl> |
|
1483 <dt>Returns: |
|
1484 <code property="yui:return"> |
|
1485 </code></dt> |
|
1486 <dd property="yui:returnInfo">void</dd> |
|
1487 </dl> |
|
1488 |
|
1489 |
|
1490 |
|
1491 |
|
1492 </div> |
|
1493 |
|
1494 </div> |
|
1495 <hr /> |
|
1496 </div> |
|
1497 <div class="private" rel="yui:method" resource="#method__resetAttrs"> |
|
1498 <h4> |
|
1499 <a name="method__resetAttrs">_resetAttrs</a></h4> |
|
1500 <div class="detail" > |
|
1501 <code> |
|
1502 private |
|
1503 static |
|
1504 |
|
1505 void |
|
1506 <strong property="yui:name">_resetAttrs</strong> |
|
1507 ( |
|
1508 |
|
1509 |
|
1510 f |
|
1511 |
|
1512 |
|
1513 , |
|
1514 a |
|
1515 |
|
1516 |
|
1517 ) |
|
1518 </code> |
|
1519 |
|
1520 <div class="description" property="yui:description"> |
|
1521 Sets the appropriate attributes and values to the HTML |
|
1522 form, in preparation of a file upload transaction. |
|
1523 </div> |
|
1524 |
|
1525 <div class="description"> |
|
1526 |
|
1527 <dl rel="yui:parameters"> |
|
1528 <dt>Parameters:</dt> |
|
1529 <dd rel="yui:parameter"> |
|
1530 <code><span property="yui:name">f</span> |
|
1531 <<span property="yui:type">object</span>> |
|
1532 </code> |
|
1533 <span property="yui:description"> HTML form object.</span> |
|
1534 </dd> |
|
1535 <dd rel="yui:parameter"> |
|
1536 <code><span property="yui:name">a</span> |
|
1537 <<span property="yui:type">object</span>> |
|
1538 </code> |
|
1539 <span property="yui:description"> Object of original attributes.</span> |
|
1540 </dd> |
|
1541 </dl> |
|
1542 |
|
1543 |
|
1544 |
|
1545 |
|
1546 |
|
1547 </div> |
|
1548 |
|
1549 </div> |
|
1550 <hr /> |
|
1551 </div> |
|
1552 <div class="private" rel="yui:method" resource="#method__serialize"> |
|
1553 <h4> |
|
1554 <a name="method__serialize">_serialize</a></h4> |
|
1555 <div class="detail" > |
|
1556 <code> |
|
1557 private |
|
1558 static |
|
1559 |
|
1560 |
|
1561 <strong property="yui:name">_serialize</strong> |
|
1562 ( |
|
1563 |
|
1564 |
|
1565 c |
|
1566 |
|
1567 |
|
1568 , |
|
1569 s |
|
1570 |
|
1571 |
|
1572 ) |
|
1573 </code> |
|
1574 |
|
1575 <div class="description" property="yui:description"> |
|
1576 Method to enumerate through an HTML form's elements collection |
|
1577 and return a string comprised of key-value pairs. |
|
1578 </div> |
|
1579 |
|
1580 <div class="description"> |
|
1581 |
|
1582 <dl rel="yui:parameters"> |
|
1583 <dt>Parameters:</dt> |
|
1584 <dd rel="yui:parameter"> |
|
1585 <code><span property="yui:name">c</span> |
|
1586 <<span property="yui:type">object</span>> |
|
1587 </code> |
|
1588 <span property="yui:description"> - YUI form node or HTML form id.</span> |
|
1589 </dd> |
|
1590 <dd rel="yui:parameter"> |
|
1591 <code><span property="yui:name">s</span> |
|
1592 <<span property="yui:type">string</span>> |
|
1593 </code> |
|
1594 <span property="yui:description"> - Transaction data defined in the configuration.</span> |
|
1595 </dd> |
|
1596 </dl> |
|
1597 |
|
1598 <dl> |
|
1599 <dt>Returns: |
|
1600 <code property="yui:return"> |
|
1601 </code></dt> |
|
1602 <dd property="yui:returnInfo">string</dd> |
|
1603 </dl> |
|
1604 |
|
1605 |
|
1606 |
|
1607 |
|
1608 </div> |
|
1609 |
|
1610 </div> |
|
1611 <hr /> |
|
1612 </div> |
|
1613 <div class="private" rel="yui:method" resource="#method__setAttrs"> |
|
1614 <h4> |
|
1615 <a name="method__setAttrs">_setAttrs</a></h4> |
|
1616 <div class="detail" > |
|
1617 <code> |
|
1618 private |
|
1619 static |
|
1620 |
|
1621 void |
|
1622 <strong property="yui:name">_setAttrs</strong> |
|
1623 ( |
|
1624 |
|
1625 |
|
1626 f |
|
1627 |
|
1628 |
|
1629 , |
|
1630 id |
|
1631 |
|
1632 |
|
1633 , |
|
1634 uri |
|
1635 |
|
1636 |
|
1637 ) |
|
1638 </code> |
|
1639 |
|
1640 <div class="description" property="yui:description"> |
|
1641 Sets the appropriate attributes and values to the HTML |
|
1642 form, in preparation of a file upload transaction. |
|
1643 </div> |
|
1644 |
|
1645 <div class="description"> |
|
1646 |
|
1647 <dl rel="yui:parameters"> |
|
1648 <dt>Parameters:</dt> |
|
1649 <dd rel="yui:parameter"> |
|
1650 <code><span property="yui:name">f</span> |
|
1651 <<span property="yui:type">object</span>> |
|
1652 </code> |
|
1653 <span property="yui:description"> HTML form object.</span> |
|
1654 </dd> |
|
1655 <dd rel="yui:parameter"> |
|
1656 <code><span property="yui:name">id</span> |
|
1657 <<span property="yui:type">object</span>> |
|
1658 </code> |
|
1659 <span property="yui:description"> The Transaction ID.</span> |
|
1660 </dd> |
|
1661 <dd rel="yui:parameter"> |
|
1662 <code><span property="yui:name">uri</span> |
|
1663 <<span property="yui:type">object</span>> |
|
1664 </code> |
|
1665 <span property="yui:description"> Qualified path to transaction resource.</span> |
|
1666 </dd> |
|
1667 </dl> |
|
1668 |
|
1669 |
|
1670 |
|
1671 |
|
1672 |
|
1673 </div> |
|
1674 |
|
1675 </div> |
|
1676 <hr /> |
|
1677 </div> |
|
1678 <div class="private" rel="yui:method" resource="#method__setHeader"> |
|
1679 <h4> |
|
1680 <a name="method__setHeader">_setHeader</a></h4> |
|
1681 <div class="detail" > |
|
1682 <code> |
|
1683 private |
|
1684 static |
|
1685 |
|
1686 |
|
1687 <strong property="yui:name">_setHeader</strong> |
|
1688 ( |
|
1689 |
|
1690 |
|
1691 l |
|
1692 |
|
1693 |
|
1694 , |
|
1695 v |
|
1696 |
|
1697 |
|
1698 ) |
|
1699 </code> |
|
1700 |
|
1701 <div class="description" property="yui:description"> |
|
1702 Method that stores default client headers for all transactions. |
|
1703 If a label is passed with no value argument, the header will be deleted. |
|
1704 </div> |
|
1705 |
|
1706 <div class="description"> |
|
1707 |
|
1708 <dl rel="yui:parameters"> |
|
1709 <dt>Parameters:</dt> |
|
1710 <dd rel="yui:parameter"> |
|
1711 <code><span property="yui:name">l</span> |
|
1712 <<span property="yui:type">string</span>> |
|
1713 </code> |
|
1714 <span property="yui:description"> - HTTP header</span> |
|
1715 </dd> |
|
1716 <dd rel="yui:parameter"> |
|
1717 <code><span property="yui:name">v</span> |
|
1718 <<span property="yui:type">string</span>> |
|
1719 </code> |
|
1720 <span property="yui:description"> - HTTP header value</span> |
|
1721 </dd> |
|
1722 </dl> |
|
1723 |
|
1724 <dl> |
|
1725 <dt>Returns: |
|
1726 <code property="yui:return"> |
|
1727 </code></dt> |
|
1728 <dd property="yui:returnInfo">int</dd> |
|
1729 </dl> |
|
1730 |
|
1731 |
|
1732 |
|
1733 |
|
1734 </div> |
|
1735 |
|
1736 </div> |
|
1737 <hr /> |
|
1738 </div> |
|
1739 <div class="private" rel="yui:method" resource="#method__setHeaders"> |
|
1740 <h4> |
|
1741 <a name="method__setHeaders">_setHeaders</a></h4> |
|
1742 <div class="detail" > |
|
1743 <code> |
|
1744 private |
|
1745 static |
|
1746 |
|
1747 |
|
1748 <strong property="yui:name">_setHeaders</strong> |
|
1749 ( |
|
1750 |
|
1751 |
|
1752 o |
|
1753 |
|
1754 |
|
1755 , |
|
1756 h |
|
1757 |
|
1758 |
|
1759 ) |
|
1760 </code> |
|
1761 |
|
1762 <div class="description" property="yui:description"> |
|
1763 Method that sets all HTTP headers to be sent in a transaction. |
|
1764 </div> |
|
1765 |
|
1766 <div class="description"> |
|
1767 |
|
1768 <dl rel="yui:parameters"> |
|
1769 <dt>Parameters:</dt> |
|
1770 <dd rel="yui:parameter"> |
|
1771 <code><span property="yui:name">o</span> |
|
1772 <<span property="yui:type">object</span>> |
|
1773 </code> |
|
1774 <span property="yui:description"> - XHR instance for the specific transaction.</span> |
|
1775 </dd> |
|
1776 <dd rel="yui:parameter"> |
|
1777 <code><span property="yui:name">h</span> |
|
1778 <<span property="yui:type">object</span>> |
|
1779 </code> |
|
1780 <span property="yui:description"> - HTTP headers for the specific transaction, as defined |
|
1781 in the configuration object passed to YUI.io().</span> |
|
1782 </dd> |
|
1783 </dl> |
|
1784 |
|
1785 <dl> |
|
1786 <dt>Returns: |
|
1787 <code property="yui:return"> |
|
1788 </code></dt> |
|
1789 <dd property="yui:returnInfo">void</dd> |
|
1790 </dl> |
|
1791 |
|
1792 |
|
1793 |
|
1794 |
|
1795 </div> |
|
1796 |
|
1797 </div> |
|
1798 <hr /> |
|
1799 </div> |
|
1800 <div class="private" rel="yui:method" resource="#method__shift"> |
|
1801 <h4> |
|
1802 <a name="method__shift">_shift</a></h4> |
|
1803 <div class="detail" > |
|
1804 <code> |
|
1805 private |
|
1806 static |
|
1807 |
|
1808 |
|
1809 <strong property="yui:name">_shift</strong> |
|
1810 ( |
|
1811 ) |
|
1812 </code> |
|
1813 |
|
1814 <div class="description" property="yui:description"> |
|
1815 Method Process the first transaction from the |
|
1816 queue in FIFO order. |
|
1817 </div> |
|
1818 |
|
1819 <div class="description"> |
|
1820 |
|
1821 |
|
1822 <dl> |
|
1823 <dt>Returns: |
|
1824 <code property="yui:return"> |
|
1825 </code></dt> |
|
1826 <dd property="yui:returnInfo">void</dd> |
|
1827 </dl> |
|
1828 |
|
1829 |
|
1830 |
|
1831 |
|
1832 </div> |
|
1833 |
|
1834 </div> |
|
1835 <hr /> |
|
1836 </div> |
|
1837 <div class="private" rel="yui:method" resource="#method__size"> |
|
1838 <h4> |
|
1839 <a name="method__size">_size</a></h4> |
|
1840 <div class="detail" > |
|
1841 <code> |
|
1842 private |
|
1843 static |
|
1844 |
|
1845 |
|
1846 <strong property="yui:name">_size</strong> |
|
1847 ( |
|
1848 ) |
|
1849 </code> |
|
1850 |
|
1851 <div class="description" property="yui:description"> |
|
1852 Method to query the current size of the queue. |
|
1853 </div> |
|
1854 |
|
1855 <div class="description"> |
|
1856 |
|
1857 |
|
1858 <dl> |
|
1859 <dt>Returns: |
|
1860 <code property="yui:return"> |
|
1861 </code></dt> |
|
1862 <dd property="yui:returnInfo">int</dd> |
|
1863 </dl> |
|
1864 |
|
1865 |
|
1866 |
|
1867 |
|
1868 </div> |
|
1869 |
|
1870 </div> |
|
1871 <hr /> |
|
1872 </div> |
|
1873 <div class="private" rel="yui:method" resource="#method__startTimeout"> |
|
1874 <h4> |
|
1875 <a name="method__startTimeout">_startTimeout</a></h4> |
|
1876 <div class="detail" > |
|
1877 <code> |
|
1878 private |
|
1879 static |
|
1880 |
|
1881 |
|
1882 <strong property="yui:name">_startTimeout</strong> |
|
1883 ( |
|
1884 |
|
1885 |
|
1886 o |
|
1887 |
|
1888 |
|
1889 , |
|
1890 c |
|
1891 |
|
1892 |
|
1893 ) |
|
1894 </code> |
|
1895 |
|
1896 <div class="description" property="yui:description"> |
|
1897 Starts timeout count if the configuration object |
|
1898 has a defined timeout property. |
|
1899 </div> |
|
1900 |
|
1901 <div class="description"> |
|
1902 |
|
1903 <dl rel="yui:parameters"> |
|
1904 <dt>Parameters:</dt> |
|
1905 <dd rel="yui:parameter"> |
|
1906 <code><span property="yui:name">o</span> |
|
1907 <<span property="yui:type">object</span>> |
|
1908 </code> |
|
1909 <span property="yui:description"> - Transaction object generated by _create().</span> |
|
1910 </dd> |
|
1911 <dd rel="yui:parameter"> |
|
1912 <code><span property="yui:name">c</span> |
|
1913 <<span property="yui:type">object</span>> |
|
1914 </code> |
|
1915 <span property="yui:description"> - Configuration object passed to YUI.io().</span> |
|
1916 </dd> |
|
1917 </dl> |
|
1918 |
|
1919 <dl> |
|
1920 <dt>Returns: |
|
1921 <code property="yui:return"> |
|
1922 </code></dt> |
|
1923 <dd property="yui:returnInfo">void</dd> |
|
1924 </dl> |
|
1925 |
|
1926 |
|
1927 |
|
1928 |
|
1929 </div> |
|
1930 |
|
1931 </div> |
|
1932 <hr /> |
|
1933 </div> |
|
1934 <div class="private" rel="yui:method" resource="#method__stop"> |
|
1935 <h4> |
|
1936 <a name="method__stop">_stop</a></h4> |
|
1937 <div class="detail" > |
|
1938 <code> |
|
1939 private |
|
1940 static |
|
1941 |
|
1942 |
|
1943 <strong property="yui:name">_stop</strong> |
|
1944 ( |
|
1945 ) |
|
1946 </code> |
|
1947 |
|
1948 <div class="description" property="yui:description"> |
|
1949 Method for setting queue processing to inactive. |
|
1950 Transaction requests to YUI.io.queue() will be stored in the queue, but |
|
1951 not processed until the queue is reset to "active". |
|
1952 </div> |
|
1953 |
|
1954 <div class="description"> |
|
1955 |
|
1956 |
|
1957 <dl> |
|
1958 <dt>Returns: |
|
1959 <code property="yui:return"> |
|
1960 </code></dt> |
|
1961 <dd property="yui:returnInfo">void</dd> |
|
1962 </dl> |
|
1963 |
|
1964 |
|
1965 |
|
1966 |
|
1967 </div> |
|
1968 |
|
1969 </div> |
|
1970 <hr /> |
|
1971 </div> |
|
1972 <div class="private" rel="yui:method" resource="#method__subscribe"> |
|
1973 <h4> |
|
1974 <a name="method__subscribe">_subscribe</a></h4> |
|
1975 <div class="detail" > |
|
1976 <code> |
|
1977 private |
|
1978 static |
|
1979 |
|
1980 |
|
1981 <strong property="yui:name">_subscribe</strong> |
|
1982 ( |
|
1983 |
|
1984 |
|
1985 e |
|
1986 |
|
1987 |
|
1988 , |
|
1989 c |
|
1990 |
|
1991 |
|
1992 ) |
|
1993 </code> |
|
1994 |
|
1995 <div class="description" property="yui:description"> |
|
1996 Method for creating and subscribing transaction events. |
|
1997 </div> |
|
1998 |
|
1999 <div class="description"> |
|
2000 |
|
2001 <dl rel="yui:parameters"> |
|
2002 <dt>Parameters:</dt> |
|
2003 <dd rel="yui:parameter"> |
|
2004 <code><span property="yui:name">e</span> |
|
2005 <<span property="yui:type">string</span>> |
|
2006 </code> |
|
2007 <span property="yui:description"> - event to be published</span> |
|
2008 </dd> |
|
2009 <dd rel="yui:parameter"> |
|
2010 <code><span property="yui:name">c</span> |
|
2011 <<span property="yui:type">object</span>> |
|
2012 </code> |
|
2013 <span property="yui:description"> - configuration data subset for event subscription.</span> |
|
2014 </dd> |
|
2015 </dl> |
|
2016 |
|
2017 <dl> |
|
2018 <dt>Returns: |
|
2019 <code property="yui:return"> |
|
2020 </code></dt> |
|
2021 <dd property="yui:returnInfo">void</dd> |
|
2022 </dl> |
|
2023 |
|
2024 |
|
2025 |
|
2026 |
|
2027 </div> |
|
2028 |
|
2029 </div> |
|
2030 <hr /> |
|
2031 </div> |
|
2032 <div class="private" rel="yui:method" resource="#method__swf"> |
|
2033 <h4> |
|
2034 <a name="method__swf">_swf</a></h4> |
|
2035 <div class="detail" > |
|
2036 <code> |
|
2037 private |
|
2038 static |
|
2039 |
|
2040 |
|
2041 <strong property="yui:name">_swf</strong> |
|
2042 ( |
|
2043 |
|
2044 |
|
2045 uri |
|
2046 |
|
2047 |
|
2048 , |
|
2049 yid |
|
2050 |
|
2051 |
|
2052 ) |
|
2053 </code> |
|
2054 |
|
2055 <div class="description" property="yui:description"> |
|
2056 Method that creates the Flash transport swf. |
|
2057 </div> |
|
2058 |
|
2059 <div class="description"> |
|
2060 |
|
2061 <dl rel="yui:parameters"> |
|
2062 <dt>Parameters:</dt> |
|
2063 <dd rel="yui:parameter"> |
|
2064 <code><span property="yui:name">uri</span> |
|
2065 <<span property="yui:type">string</span>> |
|
2066 </code> |
|
2067 <span property="yui:description"> - location of io.swf.</span> |
|
2068 </dd> |
|
2069 <dd rel="yui:parameter"> |
|
2070 <code><span property="yui:name">yid</span> |
|
2071 <<span property="yui:type">string</span>> |
|
2072 </code> |
|
2073 <span property="yui:description"> - YUI instance id.</span> |
|
2074 </dd> |
|
2075 </dl> |
|
2076 |
|
2077 <dl> |
|
2078 <dt>Returns: |
|
2079 <code property="yui:return"> |
|
2080 </code></dt> |
|
2081 <dd property="yui:returnInfo">void</dd> |
|
2082 </dl> |
|
2083 |
|
2084 |
|
2085 |
|
2086 |
|
2087 </div> |
|
2088 |
|
2089 </div> |
|
2090 <hr /> |
|
2091 </div> |
|
2092 <div class="private" rel="yui:method" resource="#method__unshift"> |
|
2093 <h4> |
|
2094 <a name="method__unshift">_unshift</a></h4> |
|
2095 <div class="detail" > |
|
2096 <code> |
|
2097 private |
|
2098 static |
|
2099 |
|
2100 |
|
2101 <strong property="yui:name">_unshift</strong> |
|
2102 ( |
|
2103 ) |
|
2104 </code> |
|
2105 |
|
2106 <div class="description" property="yui:description"> |
|
2107 Method for promoting a transaction to the top of the queue. |
|
2108 </div> |
|
2109 |
|
2110 <div class="description"> |
|
2111 |
|
2112 |
|
2113 <dl> |
|
2114 <dt>Returns: |
|
2115 <code property="yui:return"> |
|
2116 </code></dt> |
|
2117 <dd property="yui:returnInfo">void</dd> |
|
2118 </dl> |
|
2119 |
|
2120 |
|
2121 |
|
2122 |
|
2123 </div> |
|
2124 |
|
2125 </div> |
|
2126 <hr /> |
|
2127 </div> |
|
2128 <div class="private" rel="yui:method" resource="#method__upload"> |
|
2129 <h4> |
|
2130 <a name="method__upload">_upload</a></h4> |
|
2131 <div class="detail" > |
|
2132 <code> |
|
2133 private |
|
2134 static |
|
2135 |
|
2136 void |
|
2137 <strong property="yui:name">_upload</strong> |
|
2138 ( |
|
2139 |
|
2140 |
|
2141 o |
|
2142 |
|
2143 |
|
2144 , |
|
2145 uri |
|
2146 |
|
2147 |
|
2148 , |
|
2149 c |
|
2150 |
|
2151 |
|
2152 ) |
|
2153 </code> |
|
2154 |
|
2155 <div class="description" property="yui:description"> |
|
2156 Uploads HTML form data, inclusive of files/attachments, |
|
2157 using the iframe created in _create to facilitate the transaction. |
|
2158 </div> |
|
2159 |
|
2160 <div class="description"> |
|
2161 |
|
2162 <dl rel="yui:parameters"> |
|
2163 <dt>Parameters:</dt> |
|
2164 <dd rel="yui:parameter"> |
|
2165 <code><span property="yui:name">o</span> |
|
2166 <<span property="yui:type">o</span>> |
|
2167 </code> |
|
2168 <span property="yui:description"> The transaction object</span> |
|
2169 </dd> |
|
2170 <dd rel="yui:parameter"> |
|
2171 <code><span property="yui:name">uri</span> |
|
2172 <<span property="yui:type">object</span>> |
|
2173 </code> |
|
2174 <span property="yui:description"> Qualified path to transaction resource.</span> |
|
2175 </dd> |
|
2176 <dd rel="yui:parameter"> |
|
2177 <code><span property="yui:name">c</span> |
|
2178 <<span property="yui:type">object</span>> |
|
2179 </code> |
|
2180 <span property="yui:description"> Configuration object for the transaction.</span> |
|
2181 </dd> |
|
2182 </dl> |
|
2183 |
|
2184 |
|
2185 |
|
2186 |
|
2187 |
|
2188 </div> |
|
2189 |
|
2190 </div> |
|
2191 <hr /> |
|
2192 </div> |
|
2193 <div class="private" rel="yui:method" resource="#method__xdr"> |
|
2194 <h4> |
|
2195 <a name="method__xdr">_xdr</a></h4> |
|
2196 <div class="detail" > |
|
2197 <code> |
|
2198 private |
|
2199 static |
|
2200 |
|
2201 |
|
2202 <strong property="yui:name">_xdr</strong> |
|
2203 ( |
|
2204 |
|
2205 |
|
2206 o |
|
2207 |
|
2208 |
|
2209 , |
|
2210 c |
|
2211 |
|
2212 |
|
2213 ) |
|
2214 </code> |
|
2215 |
|
2216 <div class="description" property="yui:description"> |
|
2217 Sets event handlers for XDomainRequest transactions. |
|
2218 </div> |
|
2219 |
|
2220 <div class="description"> |
|
2221 |
|
2222 <dl rel="yui:parameters"> |
|
2223 <dt>Parameters:</dt> |
|
2224 <dd rel="yui:parameter"> |
|
2225 <code><span property="yui:name">o</span> |
|
2226 <<span property="yui:type">object</span>> |
|
2227 </code> |
|
2228 <span property="yui:description"> - Transaction object generated by _create() in io-base.</span> |
|
2229 </dd> |
|
2230 <dd rel="yui:parameter"> |
|
2231 <code><span property="yui:name">c</span> |
|
2232 <<span property="yui:type">object</span>> |
|
2233 </code> |
|
2234 <span property="yui:description"> - configuration object for the transaction.</span> |
|
2235 </dd> |
|
2236 </dl> |
|
2237 |
|
2238 <dl> |
|
2239 <dt>Returns: |
|
2240 <code property="yui:return"> |
|
2241 </code></dt> |
|
2242 <dd property="yui:returnInfo">void</dd> |
|
2243 </dl> |
|
2244 |
|
2245 |
|
2246 |
|
2247 |
|
2248 </div> |
|
2249 |
|
2250 </div> |
|
2251 <hr /> |
|
2252 </div> |
|
2253 <div class="private" rel="yui:method" resource="#method__xhr"> |
|
2254 <h4> |
|
2255 <a name="method__xhr">_xhr</a></h4> |
|
2256 <div class="detail" > |
|
2257 <code> |
|
2258 private |
|
2259 static |
|
2260 |
|
2261 |
|
2262 <strong property="yui:name">_xhr</strong> |
|
2263 ( |
|
2264 ) |
|
2265 </code> |
|
2266 |
|
2267 <div class="description" property="yui:description"> |
|
2268 Method that creates the XMLHttpRequest transport |
|
2269 </div> |
|
2270 |
|
2271 <div class="description"> |
|
2272 |
|
2273 |
|
2274 <dl> |
|
2275 <dt>Returns: |
|
2276 <code property="yui:return"> |
|
2277 </code></dt> |
|
2278 <dd property="yui:returnInfo">object</dd> |
|
2279 </dl> |
|
2280 |
|
2281 |
|
2282 |
|
2283 |
|
2284 </div> |
|
2285 |
|
2286 </div> |
|
2287 <hr /> |
|
2288 </div> |
|
2289 <div class="private" rel="yui:method" resource="#method_appendData"> |
|
2290 <h4> |
|
2291 <a name="method_appendData">appendData</a></h4> |
|
2292 <div class="detail" > |
|
2293 <code> |
|
2294 private |
|
2295 static |
|
2296 |
|
2297 array |
|
2298 <strong property="yui:name">appendData</strong> |
|
2299 ( |
|
2300 |
|
2301 |
|
2302 f |
|
2303 |
|
2304 |
|
2305 , |
|
2306 s |
|
2307 |
|
2308 |
|
2309 ) |
|
2310 </code> |
|
2311 |
|
2312 <div class="description" property="yui:description"> |
|
2313 Parses the POST data object and creates hidden form elements |
|
2314 for each key-value, and appends them to the HTML form object. |
|
2315 </div> |
|
2316 |
|
2317 <div class="description"> |
|
2318 |
|
2319 <dl rel="yui:parameters"> |
|
2320 <dt>Parameters:</dt> |
|
2321 <dd rel="yui:parameter"> |
|
2322 <code><span property="yui:name">f</span> |
|
2323 <<span property="yui:type">object</span>> |
|
2324 </code> |
|
2325 <span property="yui:description"> HTML form object.</span> |
|
2326 </dd> |
|
2327 <dd rel="yui:parameter"> |
|
2328 <code><span property="yui:name">s</span> |
|
2329 <<span property="yui:type">string</span>> |
|
2330 </code> |
|
2331 <span property="yui:description"> The key-value POST data.</span> |
|
2332 </dd> |
|
2333 </dl> |
|
2334 |
|
2335 <dl> |
|
2336 <dt>Returns: |
|
2337 <code property="yui:return"> |
|
2338 array |
|
2339 </code></dt> |
|
2340 <dd property="yui:returnInfo">e Array of created fields.</dd> |
|
2341 </dl> |
|
2342 |
|
2343 |
|
2344 |
|
2345 |
|
2346 </div> |
|
2347 |
|
2348 </div> |
|
2349 <hr /> |
|
2350 </div> |
|
2351 <div class="private" rel="yui:method" resource="#method_f"> |
|
2352 <h4> |
|
2353 <a name="method_f">f</a></h4> |
|
2354 <div class="detail" > |
|
2355 <code> |
|
2356 private |
|
2357 static |
|
2358 |
|
2359 void |
|
2360 <strong property="yui:name">f</strong> |
|
2361 ( |
|
2362 |
|
2363 |
|
2364 f |
|
2365 |
|
2366 |
|
2367 , |
|
2368 o |
|
2369 |
|
2370 |
|
2371 ) |
|
2372 </code> |
|
2373 |
|
2374 <div class="description" property="yui:description"> |
|
2375 Removes the custom fields created to pass additional POST |
|
2376 data, along with the HTML form fields. |
|
2377 </div> |
|
2378 |
|
2379 <div class="description"> |
|
2380 |
|
2381 <dl rel="yui:parameters"> |
|
2382 <dt>Parameters:</dt> |
|
2383 <dd rel="yui:parameter"> |
|
2384 <code><span property="yui:name">f</span> |
|
2385 <<span property="yui:type">object</span>> |
|
2386 </code> |
|
2387 <span property="yui:description"> HTML form object.</span> |
|
2388 </dd> |
|
2389 <dd rel="yui:parameter"> |
|
2390 <code><span property="yui:name">o</span> |
|
2391 <<span property="yui:type">object</span>> |
|
2392 </code> |
|
2393 <span property="yui:description"> HTML form fields created from configuration.data.</span> |
|
2394 </dd> |
|
2395 </dl> |
|
2396 |
|
2397 |
|
2398 |
|
2399 |
|
2400 |
|
2401 </div> |
|
2402 |
|
2403 </div> |
|
2404 <hr /> |
|
2405 </div> |
|
2406 <div class="" rel="yui:method" resource="#method_header"> |
|
2407 <h4> |
|
2408 <a name="method_header">header</a></h4> |
|
2409 <div class="detail" > |
|
2410 <code> |
|
2411 |
|
2412 static |
|
2413 |
|
2414 |
|
2415 <strong property="yui:name">header</strong> |
|
2416 ( |
|
2417 |
|
2418 |
|
2419 l |
|
2420 |
|
2421 |
|
2422 , |
|
2423 v |
|
2424 |
|
2425 |
|
2426 ) |
|
2427 </code> |
|
2428 |
|
2429 <div class="description" property="yui:description"> |
|
2430 Method that stores default client headers for all transactions. |
|
2431 If a label is passed with no value argument, the header will be deleted. |
|
2432 This is the interface for _setHeader(). |
|
2433 </div> |
|
2434 |
|
2435 <div class="description"> |
|
2436 |
|
2437 <dl rel="yui:parameters"> |
|
2438 <dt>Parameters:</dt> |
|
2439 <dd rel="yui:parameter"> |
|
2440 <code><span property="yui:name">l</span> |
|
2441 <<span property="yui:type">string</span>> |
|
2442 </code> |
|
2443 <span property="yui:description"> - HTTP header</span> |
|
2444 </dd> |
|
2445 <dd rel="yui:parameter"> |
|
2446 <code><span property="yui:name">v</span> |
|
2447 <<span property="yui:type">string</span>> |
|
2448 </code> |
|
2449 <span property="yui:description"> - HTTP header value</span> |
|
2450 </dd> |
|
2451 </dl> |
|
2452 |
|
2453 <dl> |
|
2454 <dt>Returns: |
|
2455 <code property="yui:return"> |
|
2456 </code></dt> |
|
2457 <dd property="yui:returnInfo">int</dd> |
|
2458 </dl> |
|
2459 |
|
2460 |
|
2461 |
|
2462 |
|
2463 </div> |
|
2464 |
|
2465 </div> |
|
2466 <hr /> |
|
2467 </div> |
|
2468 <div class="" rel="yui:method" resource="#method_io"> |
|
2469 <h4> |
|
2470 <a name="method_io">io</a></h4> |
|
2471 <div class="detail" > |
|
2472 <code> |
|
2473 |
|
2474 static |
|
2475 |
|
2476 |
|
2477 <strong property="yui:name">io</strong> |
|
2478 ( |
|
2479 |
|
2480 |
|
2481 uri |
|
2482 |
|
2483 |
|
2484 , |
|
2485 c |
|
2486 |
|
2487 |
|
2488 ) |
|
2489 </code> |
|
2490 |
|
2491 <div class="description" property="yui:description"> |
|
2492 Method for requesting a transaction. This |
|
2493 is the interface for _io(). |
|
2494 </div> |
|
2495 |
|
2496 <div class="description"> |
|
2497 |
|
2498 <dl rel="yui:parameters"> |
|
2499 <dt>Parameters:</dt> |
|
2500 <dd rel="yui:parameter"> |
|
2501 <code><span property="yui:name">uri</span> |
|
2502 <<span property="yui:type">string</span>> |
|
2503 </code> |
|
2504 <span property="yui:description"> - qualified path to transaction resource.</span> |
|
2505 </dd> |
|
2506 <dd rel="yui:parameter"> |
|
2507 <code><span property="yui:name">c</span> |
|
2508 <<span property="yui:type">object</span>> |
|
2509 </code> |
|
2510 <span property="yui:description"> - configuration object for the transaction.</span> |
|
2511 </dd> |
|
2512 </dl> |
|
2513 |
|
2514 <dl> |
|
2515 <dt>Returns: |
|
2516 <code property="yui:return"> |
|
2517 </code></dt> |
|
2518 <dd property="yui:returnInfo">object</dd> |
|
2519 </dl> |
|
2520 |
|
2521 |
|
2522 |
|
2523 |
|
2524 </div> |
|
2525 |
|
2526 </div> |
|
2527 <hr /> |
|
2528 </div> |
|
2529 <div class="" rel="yui:method" resource="#method_promote"> |
|
2530 <h4> |
|
2531 <a name="method_promote">promote</a></h4> |
|
2532 <div class="detail" > |
|
2533 <code> |
|
2534 |
|
2535 static |
|
2536 |
|
2537 |
|
2538 <strong property="yui:name">promote</strong> |
|
2539 ( |
|
2540 |
|
2541 |
|
2542 o |
|
2543 |
|
2544 |
|
2545 ) |
|
2546 </code> |
|
2547 |
|
2548 <div class="description" property="yui:description"> |
|
2549 Method for promoting a transaction to the top of the queue. |
|
2550 This is the interface for _unshift(). |
|
2551 </div> |
|
2552 |
|
2553 <div class="description"> |
|
2554 |
|
2555 <dl rel="yui:parameters"> |
|
2556 <dt>Parameters:</dt> |
|
2557 <dd rel="yui:parameter"> |
|
2558 <code><span property="yui:name">o</span> |
|
2559 <<span property="yui:type">Object</span>> |
|
2560 </code> |
|
2561 <span property="yui:description"> - Reference to queued transaction.</span> |
|
2562 </dd> |
|
2563 </dl> |
|
2564 |
|
2565 <dl> |
|
2566 <dt>Returns: |
|
2567 <code property="yui:return"> |
|
2568 </code></dt> |
|
2569 <dd property="yui:returnInfo">void</dd> |
|
2570 </dl> |
|
2571 |
|
2572 |
|
2573 |
|
2574 |
|
2575 </div> |
|
2576 |
|
2577 </div> |
|
2578 <hr /> |
|
2579 </div> |
|
2580 <div class="" rel="yui:method" resource="#method_remove"> |
|
2581 <h4> |
|
2582 <a name="method_remove">remove</a></h4> |
|
2583 <div class="detail" > |
|
2584 <code> |
|
2585 |
|
2586 static |
|
2587 |
|
2588 |
|
2589 <strong property="yui:name">remove</strong> |
|
2590 ( |
|
2591 |
|
2592 |
|
2593 o |
|
2594 |
|
2595 |
|
2596 ) |
|
2597 </code> |
|
2598 |
|
2599 <div class="description" property="yui:description"> |
|
2600 Method for removing a specific, pending transaction from |
|
2601 the queue. This is the interface for _remove(). |
|
2602 </div> |
|
2603 |
|
2604 <div class="description"> |
|
2605 |
|
2606 <dl rel="yui:parameters"> |
|
2607 <dt>Parameters:</dt> |
|
2608 <dd rel="yui:parameter"> |
|
2609 <code><span property="yui:name">o</span> |
|
2610 <<span property="yui:type">Object</span>> |
|
2611 </code> |
|
2612 <span property="yui:description"> - Reference to queued transaction.</span> |
|
2613 </dd> |
|
2614 </dl> |
|
2615 |
|
2616 <dl> |
|
2617 <dt>Returns: |
|
2618 <code property="yui:return"> |
|
2619 </code></dt> |
|
2620 <dd property="yui:returnInfo">void</dd> |
|
2621 </dl> |
|
2622 |
|
2623 |
|
2624 |
|
2625 |
|
2626 </div> |
|
2627 |
|
2628 </div> |
|
2629 <hr /> |
|
2630 </div> |
|
2631 <div class="" rel="yui:method" resource="#method_size"> |
|
2632 <h4> |
|
2633 <a name="method_size">size</a></h4> |
|
2634 <div class="detail" > |
|
2635 <code> |
|
2636 |
|
2637 static |
|
2638 |
|
2639 |
|
2640 <strong property="yui:name">size</strong> |
|
2641 ( |
|
2642 |
|
2643 |
|
2644 i |
|
2645 |
|
2646 |
|
2647 ) |
|
2648 </code> |
|
2649 |
|
2650 <div class="description" property="yui:description"> |
|
2651 Method to query the current size of the queue, or to |
|
2652 set a maximum queue size. This is the interface for _size(). |
|
2653 </div> |
|
2654 |
|
2655 <div class="description"> |
|
2656 |
|
2657 <dl rel="yui:parameters"> |
|
2658 <dt>Parameters:</dt> |
|
2659 <dd rel="yui:parameter"> |
|
2660 <code><span property="yui:name">i</span> |
|
2661 <<span property="yui:type">number</span>> |
|
2662 </code> |
|
2663 <span property="yui:description"> - Specified maximum size of queue.</span> |
|
2664 </dd> |
|
2665 </dl> |
|
2666 |
|
2667 <dl> |
|
2668 <dt>Returns: |
|
2669 <code property="yui:return"> |
|
2670 </code></dt> |
|
2671 <dd property="yui:returnInfo">number</dd> |
|
2672 </dl> |
|
2673 |
|
2674 |
|
2675 |
|
2676 |
|
2677 </div> |
|
2678 |
|
2679 </div> |
|
2680 <hr /> |
|
2681 </div> |
|
2682 <div class="" rel="yui:method" resource="#method_start"> |
|
2683 <h4> |
|
2684 <a name="method_start">start</a></h4> |
|
2685 <div class="detail" > |
|
2686 <code> |
|
2687 |
|
2688 static |
|
2689 |
|
2690 |
|
2691 <strong property="yui:name">start</strong> |
|
2692 ( |
|
2693 ) |
|
2694 </code> |
|
2695 |
|
2696 <div class="description" property="yui:description"> |
|
2697 Method for setting the queue to active. If there are |
|
2698 transactions pending in the queue, they will be processed from the |
|
2699 queue in FIFO order. This is the interface for _start(). |
|
2700 </div> |
|
2701 |
|
2702 <div class="description"> |
|
2703 |
|
2704 |
|
2705 <dl> |
|
2706 <dt>Returns: |
|
2707 <code property="yui:return"> |
|
2708 </code></dt> |
|
2709 <dd property="yui:returnInfo">void</dd> |
|
2710 </dl> |
|
2711 |
|
2712 |
|
2713 |
|
2714 |
|
2715 </div> |
|
2716 |
|
2717 </div> |
|
2718 <hr /> |
|
2719 </div> |
|
2720 <div class="" rel="yui:method" resource="#method_stop"> |
|
2721 <h4> |
|
2722 <a name="method_stop">stop</a></h4> |
|
2723 <div class="detail" > |
|
2724 <code> |
|
2725 |
|
2726 static |
|
2727 |
|
2728 |
|
2729 <strong property="yui:name">stop</strong> |
|
2730 ( |
|
2731 ) |
|
2732 </code> |
|
2733 |
|
2734 <div class="description" property="yui:description"> |
|
2735 Method for setting queue processing to inactive. |
|
2736 Transaction requests to YUI.io.queue() will be stored in the queue, but |
|
2737 not processed until the queue is restarted. This is the |
|
2738 interface for _stop(). |
|
2739 </div> |
|
2740 |
|
2741 <div class="description"> |
|
2742 |
|
2743 |
|
2744 <dl> |
|
2745 <dt>Returns: |
|
2746 <code property="yui:return"> |
|
2747 </code></dt> |
|
2748 <dd property="yui:returnInfo">void</dd> |
|
2749 </dl> |
|
2750 |
|
2751 |
|
2752 |
|
2753 |
|
2754 </div> |
|
2755 |
|
2756 </div> |
|
2757 <hr /> |
|
2758 </div> |
|
2759 <div class="" rel="yui:method" resource="#method_transport"> |
|
2760 <h4> |
|
2761 <a name="method_transport">transport</a></h4> |
|
2762 <div class="detail" > |
|
2763 <code> |
|
2764 |
|
2765 static |
|
2766 |
|
2767 |
|
2768 <strong property="yui:name">transport</strong> |
|
2769 ( |
|
2770 |
|
2771 |
|
2772 o |
|
2773 |
|
2774 |
|
2775 ) |
|
2776 </code> |
|
2777 |
|
2778 <div class="description" property="yui:description"> |
|
2779 Method to initialize the desired transport. |
|
2780 </div> |
|
2781 |
|
2782 <div class="description"> |
|
2783 |
|
2784 <dl rel="yui:parameters"> |
|
2785 <dt>Parameters:</dt> |
|
2786 <dd rel="yui:parameter"> |
|
2787 <code><span property="yui:name">o</span> |
|
2788 <<span property="yui:type">object</span>> |
|
2789 </code> |
|
2790 <span property="yui:description"> - object of transport configurations.</span> |
|
2791 </dd> |
|
2792 </dl> |
|
2793 |
|
2794 <dl> |
|
2795 <dt>Returns: |
|
2796 <code property="yui:return"> |
|
2797 </code></dt> |
|
2798 <dd property="yui:returnInfo">void</dd> |
|
2799 </dl> |
|
2800 |
|
2801 |
|
2802 |
|
2803 |
|
2804 </div> |
|
2805 |
|
2806 </div> |
|
2807 <hr /> |
|
2808 </div> |
|
2809 <div class="private" rel="yui:method" resource="#method_xdrReady"> |
|
2810 <h4> |
|
2811 <a name="method_xdrReady">xdrReady</a></h4> |
|
2812 <div class="detail" > |
|
2813 <code> |
|
2814 private |
|
2815 static |
|
2816 |
|
2817 |
|
2818 <strong property="yui:name">xdrReady</strong> |
|
2819 ( |
|
2820 |
|
2821 |
|
2822 id |
|
2823 |
|
2824 |
|
2825 , |
|
2826 c |
|
2827 |
|
2828 |
|
2829 ) |
|
2830 </code> |
|
2831 |
|
2832 <div class="description" property="yui:description"> |
|
2833 Fires event "io:xdrReady" |
|
2834 </div> |
|
2835 |
|
2836 <div class="description"> |
|
2837 |
|
2838 <dl rel="yui:parameters"> |
|
2839 <dt>Parameters:</dt> |
|
2840 <dd rel="yui:parameter"> |
|
2841 <code><span property="yui:name">id</span> |
|
2842 <<span property="yui:type">number</span>> |
|
2843 </code> |
|
2844 <span property="yui:description"> - transaction id</span> |
|
2845 </dd> |
|
2846 <dd rel="yui:parameter"> |
|
2847 <code><span property="yui:name">c</span> |
|
2848 <<span property="yui:type">object</span>> |
|
2849 </code> |
|
2850 <span property="yui:description"> - configuration object for the transaction.</span> |
|
2851 </dd> |
|
2852 </dl> |
|
2853 |
|
2854 <dl> |
|
2855 <dt>Returns: |
|
2856 <code property="yui:return"> |
|
2857 </code></dt> |
|
2858 <dd property="yui:returnInfo">void</dd> |
|
2859 </dl> |
|
2860 |
|
2861 |
|
2862 |
|
2863 |
|
2864 </div> |
|
2865 |
|
2866 </div> |
|
2867 <hr /> |
|
2868 </div> |
|
2869 <div class="private" rel="yui:method" resource="#method_xdrResponse"> |
|
2870 <h4> |
|
2871 <a name="method_xdrResponse">xdrResponse</a></h4> |
|
2872 <div class="detail" > |
|
2873 <code> |
|
2874 private |
|
2875 static |
|
2876 |
|
2877 |
|
2878 <strong property="yui:name">xdrResponse</strong> |
|
2879 ( |
|
2880 |
|
2881 |
|
2882 o |
|
2883 |
|
2884 |
|
2885 , |
|
2886 c |
|
2887 |
|
2888 |
|
2889 , |
|
2890 e |
|
2891 |
|
2892 |
|
2893 ) |
|
2894 </code> |
|
2895 |
|
2896 <div class="description" property="yui:description"> |
|
2897 Response controller for cross-domain requests when using the |
|
2898 Flash transport or IE8's XDomainRequest object. |
|
2899 </div> |
|
2900 |
|
2901 <div class="description"> |
|
2902 |
|
2903 <dl rel="yui:parameters"> |
|
2904 <dt>Parameters:</dt> |
|
2905 <dd rel="yui:parameter"> |
|
2906 <code><span property="yui:name">o</span> |
|
2907 <<span property="yui:type">object</span>> |
|
2908 </code> |
|
2909 <span property="yui:description"> - Transaction object generated by _create() in io-base.</span> |
|
2910 </dd> |
|
2911 <dd rel="yui:parameter"> |
|
2912 <code><span property="yui:name">c</span> |
|
2913 <<span property="yui:type">object</span>> |
|
2914 </code> |
|
2915 <span property="yui:description"> - configuration object for the transaction.</span> |
|
2916 </dd> |
|
2917 <dd rel="yui:parameter"> |
|
2918 <code><span property="yui:name">e</span> |
|
2919 <<span property="yui:type">string</span>> |
|
2920 </code> |
|
2921 <span property="yui:description"> - Event name</span> |
|
2922 </dd> |
|
2923 </dl> |
|
2924 |
|
2925 <dl> |
|
2926 <dt>Returns: |
|
2927 <code property="yui:return"> |
|
2928 </code></dt> |
|
2929 <dd property="yui:returnInfo">object</dd> |
|
2930 </dl> |
|
2931 |
|
2932 |
|
2933 |
|
2934 |
|
2935 </div> |
|
2936 |
|
2937 </div> |
|
2938 <hr /> |
|
2939 </div> |
|
2940 </div> |
|
2941 </div> |
|
2942 |
|
2943 </div> |
|
2944 |
|
2945 <div rel="yui:events" resource="#events"> |
|
2946 <div class="section method details"> |
|
2947 <h3 id="events">Events</h3> |
|
2948 <div class="content"> |
|
2949 <div class="" rel="yui:event" resource="#event_io:complete"> |
|
2950 <h4> |
|
2951 <a name="event_io:complete">io:complete</a></h4> |
|
2952 <div class="detail"> |
|
2953 <code> |
|
2954 |
|
2955 |
|
2956 |
|
2957 <strong property="yui:name">io:complete</strong> |
|
2958 |
|
2959 ( |
|
2960 ) |
|
2961 |
|
2962 </code> |
|
2963 |
|
2964 <div class="description" property="yui:description"> |
|
2965 This event is fired by YUI.io when a transaction is complete. |
|
2966 Response status and data are accessible, if available. |
|
2967 </div> |
|
2968 |
|
2969 <div class="description"> |
|
2970 |
|
2971 |
|
2972 |
|
2973 |
|
2974 </div> |
|
2975 |
|
2976 </div> |
|
2977 <hr /> |
|
2978 </div> |
|
2979 <div class="" rel="yui:event" resource="#event_io:end"> |
|
2980 <h4> |
|
2981 <a name="event_io:end">io:end</a></h4> |
|
2982 <div class="detail"> |
|
2983 <code> |
|
2984 |
|
2985 |
|
2986 |
|
2987 <strong property="yui:name">io:end</strong> |
|
2988 |
|
2989 ( |
|
2990 ) |
|
2991 |
|
2992 </code> |
|
2993 |
|
2994 <div class="description" property="yui:description"> |
|
2995 This event signifies the end of the transaction lifecycle. The |
|
2996 transaction transport is destroyed. |
|
2997 </div> |
|
2998 |
|
2999 <div class="description"> |
|
3000 |
|
3001 |
|
3002 |
|
3003 |
|
3004 </div> |
|
3005 |
|
3006 </div> |
|
3007 <hr /> |
|
3008 </div> |
|
3009 <div class="" rel="yui:event" resource="#event_io:failure"> |
|
3010 <h4> |
|
3011 <a name="event_io:failure">io:failure</a></h4> |
|
3012 <div class="detail"> |
|
3013 <code> |
|
3014 |
|
3015 |
|
3016 |
|
3017 <strong property="yui:name">io:failure</strong> |
|
3018 |
|
3019 ( |
|
3020 ) |
|
3021 |
|
3022 </code> |
|
3023 |
|
3024 <div class="description" property="yui:description"> |
|
3025 This event is fired by YUI.io when a transaction is complete, and |
|
3026 the HTTP status resolves to HTTP4xx, 5xx and above. |
|
3027 </div> |
|
3028 |
|
3029 <div class="description"> |
|
3030 |
|
3031 |
|
3032 |
|
3033 |
|
3034 </div> |
|
3035 |
|
3036 </div> |
|
3037 <hr /> |
|
3038 </div> |
|
3039 <div class="" rel="yui:event" resource="#event_io:start"> |
|
3040 <h4> |
|
3041 <a name="event_io:start">io:start</a></h4> |
|
3042 <div class="detail"> |
|
3043 <code> |
|
3044 |
|
3045 |
|
3046 |
|
3047 <strong property="yui:name">io:start</strong> |
|
3048 |
|
3049 ( |
|
3050 ) |
|
3051 |
|
3052 </code> |
|
3053 |
|
3054 <div class="description" property="yui:description"> |
|
3055 This event is fired by YUI.io when a transaction is initiated. |
|
3056 </div> |
|
3057 |
|
3058 <div class="description"> |
|
3059 |
|
3060 |
|
3061 |
|
3062 |
|
3063 </div> |
|
3064 |
|
3065 </div> |
|
3066 <hr /> |
|
3067 </div> |
|
3068 <div class="" rel="yui:event" resource="#event_io:success"> |
|
3069 <h4> |
|
3070 <a name="event_io:success">io:success</a></h4> |
|
3071 <div class="detail"> |
|
3072 <code> |
|
3073 |
|
3074 |
|
3075 |
|
3076 <strong property="yui:name">io:success</strong> |
|
3077 |
|
3078 ( |
|
3079 ) |
|
3080 |
|
3081 </code> |
|
3082 |
|
3083 <div class="description" property="yui:description"> |
|
3084 This event is fired by YUI.io when a transaction is complete, and |
|
3085 the HTTP status resolves to HTTP2xx. |
|
3086 </div> |
|
3087 |
|
3088 <div class="description"> |
|
3089 |
|
3090 |
|
3091 |
|
3092 |
|
3093 </div> |
|
3094 |
|
3095 </div> |
|
3096 <hr /> |
|
3097 </div> |
|
3098 <div class="" rel="yui:event" resource="#event_io:xdrReady"> |
|
3099 <h4> |
|
3100 <a name="event_io:xdrReady">io:xdrReady</a></h4> |
|
3101 <div class="detail"> |
|
3102 <code> |
|
3103 |
|
3104 |
|
3105 |
|
3106 <strong property="yui:name">io:xdrReady</strong> |
|
3107 |
|
3108 ( |
|
3109 ) |
|
3110 |
|
3111 </code> |
|
3112 |
|
3113 <div class="description" property="yui:description"> |
|
3114 This event is fired by YUI.io when the specified transport is |
|
3115 ready for use. |
|
3116 </div> |
|
3117 |
|
3118 <div class="description"> |
|
3119 |
|
3120 |
|
3121 |
|
3122 |
|
3123 </div> |
|
3124 |
|
3125 </div> |
|
3126 <hr /> |
|
3127 </div> |
|
3128 </div> |
|
3129 </div> |
|
3130 |
|
3131 |
|
3132 </div> |
|
3133 |
|
3134 <div rel="yui:attributes" resource="#configattributes"> |
|
3135 |
|
3136 </div> |
|
3137 |
|
3138 </div> |
|
3139 </div> |
|
3140 <div class="yui-b"> |
|
3141 <div class="nav"> |
|
3142 |
|
3143 <div id="moduleList" class="module"> |
|
3144 <h4>Modules</h4> |
|
3145 <ul class="content"> |
|
3146 <li class=""><a href="module_anim.html" title="anim">anim</a></li> |
|
3147 <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li> |
|
3148 <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li> |
|
3149 <li class=""><a href="module_base.html" title="base">base</a></li> |
|
3150 <li class=""><a href="module_cache.html" title="cache">cache</a></li> |
|
3151 <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li> |
|
3152 <li class=""><a href="module_collection.html" title="collection">collection</a></li> |
|
3153 <li class=""><a href="module_console.html" title="console">console</a></li> |
|
3154 <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li> |
|
3155 <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li> |
|
3156 <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li> |
|
3157 <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li> |
|
3158 <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li> |
|
3159 <li class=""><a href="module_dd.html" title="dd">dd</a></li> |
|
3160 <li class=""><a href="module_dom.html" title="dom">dom</a></li> |
|
3161 <li class=""><a href="module_dump.html" title="dump">dump</a></li> |
|
3162 <li class=""><a href="module_event.html" title="event">event</a></li> |
|
3163 <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li> |
|
3164 <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li> |
|
3165 <li class=""><a href="module_history.html" title="history">history</a></li> |
|
3166 <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li> |
|
3167 <li class="selected"><a href="module_io.html" title="io">io</a></li> |
|
3168 <li class=""><a href="module_json.html" title="json">json</a></li> |
|
3169 <li class=""><a href="module_node.html" title="node">node</a></li> |
|
3170 <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li> |
|
3171 <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li> |
|
3172 <li class=""><a href="module_oop.html" title="oop">oop</a></li> |
|
3173 <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li> |
|
3174 <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li> |
|
3175 <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li> |
|
3176 <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li> |
|
3177 <li class=""><a href="module_slider.html" title="slider">slider</a></li> |
|
3178 <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li> |
|
3179 <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li> |
|
3180 <li class=""><a href="module_test.html" title="test">test</a></li> |
|
3181 <li class=""><a href="module_widget.html" title="widget">widget</a></li> |
|
3182 <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li> |
|
3183 <li class=""><a href="module_widget-position-ext.html" title="widget-position-ext">widget-position-ext</a></li> |
|
3184 <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li> |
|
3185 <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li> |
|
3186 <li class=""><a href="module_yui.html" title="yui">yui</a></li> |
|
3187 </ul> |
|
3188 </div> |
|
3189 |
|
3190 <div id="classList" class="module"> |
|
3191 <h4>Classes</h4> |
|
3192 <ul class="content"> |
|
3193 <li class="selected"><a href="io.html" title="io">io</a></li> |
|
3194 </ul> |
|
3195 </div> |
|
3196 |
|
3197 <div id="fileList" class="module"> |
|
3198 <h4>Files</h4> |
|
3199 <ul class="content"> |
|
3200 <li class=""><a href="io-base.js.html" title="io-base.js">io-base.js</a></li> |
|
3201 <li class=""><a href="io-form.js.html" title="io-form.js">io-form.js</a></li> |
|
3202 <li class=""><a href="io-queue.js.html" title="io-queue.js">io-queue.js</a></li> |
|
3203 <li class=""><a href="io-upload-iframe.js.html" title="io-upload-iframe.js">io-upload-iframe.js</a></li> |
|
3204 <li class=""><a href="io-xdr.js.html" title="io-xdr.js">io-xdr.js</a></li> |
|
3205 </ul> |
|
3206 </div> |
|
3207 |
|
3208 <div id="propertyList" class="module"> |
|
3209 <h4>Properties</h4> |
|
3210 <ul class="content"> |
|
3211 <li class="private"><a href="#property__e" title="_e">_e</a></li> |
|
3212 <li class="private"><a href="#property__fn" title="_fn">_fn</a></li> |
|
3213 <li class="private"><a href="#property__headers" title="_headers">_headers</a></li> |
|
3214 <li class="private"><a href="#property__qState" title="_qState">_qState</a></li> |
|
3215 <li class="private"><a href="#property__rS" title="_rS">_rS</a></li> |
|
3216 <li class="private"><a href="#property__timeout" title="_timeout">_timeout</a></li> |
|
3217 <li class="private"><a href="#property__transport" title="_transport">_transport</a></li> |
|
3218 <li class="private"><a href="#property__yQ" title="_yQ">_yQ</a></li> |
|
3219 <li class="private"><a href="#property_transactionId" title="transactionId">transactionId</a></li> |
|
3220 </ul> |
|
3221 </div> |
|
3222 |
|
3223 <div id="methodsList" class="module"> |
|
3224 <h4>Methods</h4> |
|
3225 <ul class="content"> |
|
3226 <li class="private"><a href="#method__abort" title="_abort">_abort</a></li> |
|
3227 <li class="private"><a href="#method__clearTimeout" title="_clearTimeout">_clearTimeout</a></li> |
|
3228 <li class="private"><a href="#method__concat" title="_concat">_concat</a></li> |
|
3229 <li class="private"><a href="#method__create" title="_create">_create</a></li> |
|
3230 <li class="private"><a href="#method__data" title="_data">_data</a></li> |
|
3231 <li class="private"><a href="#method__destroy" title="_destroy">_destroy</a></li> |
|
3232 <li class="private"><a href="#method__handle" title="_handle">_handle</a></li> |
|
3233 <li class="private"><a href="#method__handleResponse" title="_handleResponse">_handleResponse</a></li> |
|
3234 <li class="private"><a href="#method__id" title="_id">_id</a></li> |
|
3235 <li class="private"><a href="#method__io" title="_io">_io</a></li> |
|
3236 <li class="private"><a href="#method__ioCancel" title="_ioCancel">_ioCancel</a></li> |
|
3237 <li class="private"><a href="#method__ioComplete" title="_ioComplete">_ioComplete</a></li> |
|
3238 <li class="private"><a href="#method__ioEnd" title="_ioEnd">_ioEnd</a></li> |
|
3239 <li class="private"><a href="#method__ioFailure" title="_ioFailure">_ioFailure</a></li> |
|
3240 <li class="private"><a href="#method__ioStart" title="_ioStart">_ioStart</a></li> |
|
3241 <li class="private"><a href="#method__ioSuccess" title="_ioSuccess">_ioSuccess</a></li> |
|
3242 <li class="private"><a href="#method__isInProgress." title="_isInProgress.">_isInProgress.</a></li> |
|
3243 <li class="private"><a href="#method__queue" title="_queue">_queue</a></li> |
|
3244 <li class="private"><a href="#method__readyState" title="_readyState">_readyState</a></li> |
|
3245 <li class="private"><a href="#method__remove" title="_remove">_remove</a></li> |
|
3246 <li class="private"><a href="#method__resend" title="_resend">_resend</a></li> |
|
3247 <li class="private"><a href="#method__resetAttrs" title="_resetAttrs">_resetAttrs</a></li> |
|
3248 <li class="private"><a href="#method__serialize" title="_serialize">_serialize</a></li> |
|
3249 <li class="private"><a href="#method__setAttrs" title="_setAttrs">_setAttrs</a></li> |
|
3250 <li class="private"><a href="#method__setHeader" title="_setHeader">_setHeader</a></li> |
|
3251 <li class="private"><a href="#method__setHeaders" title="_setHeaders">_setHeaders</a></li> |
|
3252 <li class="private"><a href="#method__shift" title="_shift">_shift</a></li> |
|
3253 <li class="private"><a href="#method__size" title="_size">_size</a></li> |
|
3254 <li class="private"><a href="#method__startTimeout" title="_startTimeout">_startTimeout</a></li> |
|
3255 <li class="private"><a href="#method__stop" title="_stop">_stop</a></li> |
|
3256 <li class="private"><a href="#method__subscribe" title="_subscribe">_subscribe</a></li> |
|
3257 <li class="private"><a href="#method__swf" title="_swf">_swf</a></li> |
|
3258 <li class="private"><a href="#method__unshift" title="_unshift">_unshift</a></li> |
|
3259 <li class="private"><a href="#method__upload" title="_upload">_upload</a></li> |
|
3260 <li class="private"><a href="#method__xdr" title="_xdr">_xdr</a></li> |
|
3261 <li class="private"><a href="#method__xhr" title="_xhr">_xhr</a></li> |
|
3262 <li class="private"><a href="#method_appendData" title="appendData">appendData</a></li> |
|
3263 <li class="private"><a href="#method_f" title="f">f</a></li> |
|
3264 <li class=""><a href="#method_header" title="header">header</a></li> |
|
3265 <li class=""><a href="#method_io" title="io">io</a></li> |
|
3266 <li class=""><a href="#method_promote" title="promote">promote</a></li> |
|
3267 <li class=""><a href="#method_remove" title="remove">remove</a></li> |
|
3268 <li class=""><a href="#method_size" title="size">size</a></li> |
|
3269 <li class=""><a href="#method_start" title="start">start</a></li> |
|
3270 <li class=""><a href="#method_stop" title="stop">stop</a></li> |
|
3271 <li class=""><a href="#method_transport" title="transport">transport</a></li> |
|
3272 <li class="private"><a href="#method_xdrReady" title="xdrReady">xdrReady</a></li> |
|
3273 <li class="private"><a href="#method_xdrResponse" title="xdrResponse">xdrResponse</a></li> |
|
3274 </ul> |
|
3275 </div> |
|
3276 |
|
3277 <div id="eventsList" class="module"> |
|
3278 <h4>Events</h4> |
|
3279 <ul class="content"> |
|
3280 <li class=""><a href="#event_io:complete" title="io:complete">io:complete</a></li> |
|
3281 <li class=""><a href="#event_io:end" title="io:end">io:end</a></li> |
|
3282 <li class=""><a href="#event_io:failure" title="io:failure">io:failure</a></li> |
|
3283 <li class=""><a href="#event_io:start" title="io:start">io:start</a></li> |
|
3284 <li class=""><a href="#event_io:success" title="io:success">io:success</a></li> |
|
3285 <li class=""><a href="#event_io:xdrReady" title="io:xdrReady">io:xdrReady</a></li> |
|
3286 </ul> |
|
3287 </div> |
|
3288 |
|
3289 |
|
3290 </div> |
|
3291 </div> |
|
3292 </div> |
|
3293 <div id="ft"> |
|
3294 <hr /> |
|
3295 Copyright © 2009 Yahoo! Inc. All rights reserved. |
|
3296 </div> |
|
3297 </div> |
|
3298 <script type="text/javascript"> |
|
3299 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"}]; |
|
3300 </script> |
|
3301 </body> |
|
3302 </html> |