<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IO - YUI 3</title>
<link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
<link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="../assets/favicon.png">
<script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">
<div id="doc">
<div id="hd" class="yui3-g header">
<div class="yui3-u-3-4">
<h1><img src="../assets/css/logo.png" title="YUI 3"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 3.10.3</em>
</div>
</div>
<div id="bd" class="yui3-g">
<div class="yui3-u-1-4">
<div id="docs-sidebar" class="sidebar apidocs">
<div id="api-list">
<h2 class="off-left">APIs</h2>
<div id="api-tabview" class="tabview">
<ul class="tabs">
<li><a href="#api-classes">Classes</a></li>
<li><a href="#api-modules">Modules</a></li>
</ul>
<div id="api-tabview-filter">
<input type="search" id="api-filter" placeholder="Type to filter APIs">
</div>
<div id="api-tabview-panel">
<ul id="api-classes" class="apis classes">
<li><a href="../classes/Anim.html">Anim</a></li>
<li><a href="../classes/App.html">App</a></li>
<li><a href="../classes/App.Base.html">App.Base</a></li>
<li><a href="../classes/App.Content.html">App.Content</a></li>
<li><a href="../classes/App.Transitions.html">App.Transitions</a></li>
<li><a href="../classes/App.TransitionsNative.html">App.TransitionsNative</a></li>
<li><a href="../classes/AreaSeries.html">AreaSeries</a></li>
<li><a href="../classes/AreaSplineSeries.html">AreaSplineSeries</a></li>
<li><a href="../classes/Array.html">Array</a></li>
<li><a href="../classes/ArrayList.html">ArrayList</a></li>
<li><a href="../classes/ArraySort.html">ArraySort</a></li>
<li><a href="../classes/AsyncQueue.html">AsyncQueue</a></li>
<li><a href="../classes/Attribute.html">Attribute</a></li>
<li><a href="../classes/AttributeCore.html">AttributeCore</a></li>
<li><a href="../classes/AttributeEvents.html">AttributeEvents</a></li>
<li><a href="../classes/AttributeExtras.html">AttributeExtras</a></li>
<li><a href="../classes/AttributeLite.html">AttributeLite</a></li>
<li><a href="../classes/AttributeObservable.html">AttributeObservable</a></li>
<li><a href="../classes/AutoComplete.html">AutoComplete</a></li>
<li><a href="../classes/AutoCompleteBase.html">AutoCompleteBase</a></li>
<li><a href="../classes/AutoCompleteFilters.html">AutoCompleteFilters</a></li>
<li><a href="../classes/AutoCompleteHighlighters.html">AutoCompleteHighlighters</a></li>
<li><a href="../classes/AutoCompleteList.html">AutoCompleteList</a></li>
<li><a href="../classes/Axis.html">Axis</a></li>
<li><a href="../classes/AxisBase.html">AxisBase</a></li>
<li><a href="../classes/BarSeries.html">BarSeries</a></li>
<li><a href="../classes/Base.html">Base</a></li>
<li><a href="../classes/BaseCore.html">BaseCore</a></li>
<li><a href="../classes/BaseObservable.html">BaseObservable</a></li>
<li><a href="../classes/BottomAxisLayout.html">BottomAxisLayout</a></li>
<li><a href="../classes/Button.html">Button</a></li>
<li><a href="../classes/ButtonCore.html">ButtonCore</a></li>
<li><a href="../classes/ButtonGroup.html">ButtonGroup</a></li>
<li><a href="../classes/Cache.html">Cache</a></li>
<li><a href="../classes/CacheOffline.html">CacheOffline</a></li>
<li><a href="../classes/Calendar.html">Calendar</a></li>
<li><a href="../classes/CalendarBase.html">CalendarBase</a></li>
<li><a href="../classes/CandlestickSeries.html">CandlestickSeries</a></li>
<li><a href="../classes/CanvasCircle.html">CanvasCircle</a></li>
<li><a href="../classes/CanvasDrawing.html">CanvasDrawing</a></li>
<li><a href="../classes/CanvasEllipse.html">CanvasEllipse</a></li>
<li><a href="../classes/CanvasGraphic.html">CanvasGraphic</a></li>
<li><a href="../classes/CanvasPath.html">CanvasPath</a></li>
<li><a href="../classes/CanvasPieSlice.html">CanvasPieSlice</a></li>
<li><a href="../classes/CanvasRect.html">CanvasRect</a></li>
<li><a href="../classes/CanvasShape.html">CanvasShape</a></li>
<li><a href="../classes/CartesianChart.html">CartesianChart</a></li>
<li><a href="../classes/CartesianSeries.html">CartesianSeries</a></li>
<li><a href="../classes/CategoryAxis.html">CategoryAxis</a></li>
<li><a href="../classes/CategoryAxisBase.html">CategoryAxisBase</a></li>
<li><a href="../classes/CategoryImpl.html">CategoryImpl</a></li>
<li><a href="../classes/Chart.html">Chart</a></li>
<li><a href="../classes/ChartBase.html">ChartBase</a></li>
<li><a href="../classes/ChartLegend.html">ChartLegend</a></li>
<li><a href="../classes/Circle.html">Circle</a></li>
<li><a href="../classes/CircleGroup.html">CircleGroup</a></li>
<li><a href="../classes/ClassNameManager.html">ClassNameManager</a></li>
<li><a href="../classes/ClickableRail.html">ClickableRail</a></li>
<li><a href="../classes/Color.html">Color</a></li>
<li><a href="../classes/Color.Harmony.html">Color.Harmony</a></li>
<li><a href="../classes/Color.HSL.html">Color.HSL</a></li>
<li><a href="../classes/Color.HSV.html">Color.HSV</a></li>
<li><a href="../classes/ColumnSeries.html">ColumnSeries</a></li>
<li><a href="../classes/ComboSeries.html">ComboSeries</a></li>
<li><a href="../classes/ComboSplineSeries.html">ComboSplineSeries</a></li>
<li><a href="../classes/config.html">config</a></li>
<li><a href="../classes/Console.html">Console</a></li>
<li><a href="../classes/Controller.html">Controller</a></li>
<li><a href="../classes/Cookie.html">Cookie</a></li>
<li><a href="../classes/CurveUtil.html">CurveUtil</a></li>
<li><a href="../classes/CustomEvent.html">CustomEvent</a></li>
<li><a href="../classes/DataSchema.Array.html">DataSchema.Array</a></li>
<li><a href="../classes/DataSchema.Base.html">DataSchema.Base</a></li>
<li><a href="../classes/DataSchema.JSON.html">DataSchema.JSON</a></li>
<li><a href="../classes/DataSchema.Text.html">DataSchema.Text</a></li>
<li><a href="../classes/DataSchema.XML.html">DataSchema.XML</a></li>
<li><a href="../classes/DataSource.Function.html">DataSource.Function</a></li>
<li><a href="../classes/DataSource.Get.html">DataSource.Get</a></li>
<li><a href="../classes/DataSource.IO.html">DataSource.IO</a></li>
<li><a href="../classes/DataSource.Local.html">DataSource.Local</a></li>
<li><a href="../classes/DataSourceArraySchema.html">DataSourceArraySchema</a></li>
<li><a href="../classes/DataSourceCache.html">DataSourceCache</a></li>
<li><a href="../classes/DataSourceCacheExtension.html">DataSourceCacheExtension</a></li>
<li><a href="../classes/DataSourceJSONSchema.html">DataSourceJSONSchema</a></li>
<li><a href="../classes/DataSourceTextSchema.html">DataSourceTextSchema</a></li>
<li><a href="../classes/DataSourceXMLSchema.html">DataSourceXMLSchema</a></li>
<li><a href="../classes/DataTable.html">DataTable</a></li>
<li><a href="../classes/DataTable.Base.html">DataTable.Base</a></li>
<li><a href="../classes/DataTable.BodyView.html">DataTable.BodyView</a></li>
<li><a href="../classes/DataTable.BodyView.Formatters.html">DataTable.BodyView.Formatters</a></li>
<li><a href="../classes/DataTable.ColumnWidths.html">DataTable.ColumnWidths</a></li>
<li><a href="../classes/DataTable.Core.html">DataTable.Core</a></li>
<li><a href="../classes/DataTable.HeaderView.html">DataTable.HeaderView</a></li>
<li><a href="../classes/DataTable.Message.html">DataTable.Message</a></li>
<li><a href="../classes/DataTable.Mutable.html">DataTable.Mutable</a></li>
<li><a href="../classes/DataTable.Scrollable.html">DataTable.Scrollable</a></li>
<li><a href="../classes/DataTable.Sortable.html">DataTable.Sortable</a></li>
<li><a href="../classes/DataTable.TableView.html">DataTable.TableView</a></li>
<li><a href="../classes/Date.html">Date</a></li>
<li><a href="../classes/DD.DDM.html">DD.DDM</a></li>
<li><a href="../classes/DD.Delegate.html">DD.Delegate</a></li>
<li><a href="../classes/DD.Drag.html">DD.Drag</a></li>
<li><a href="../classes/DD.Drop.html">DD.Drop</a></li>
<li><a href="../classes/DD.Scroll.html">DD.Scroll</a></li>
<li><a href="../classes/Dial.html">Dial</a></li>
<li><a href="../classes/Do.html">Do</a></li>
<li><a href="../classes/Do.AlterArgs.html">Do.AlterArgs</a></li>
<li><a href="../classes/Do.AlterReturn.html">Do.AlterReturn</a></li>
<li><a href="../classes/Do.Error.html">Do.Error</a></li>
<li><a href="../classes/Do.Halt.html">Do.Halt</a></li>
<li><a href="../classes/Do.Method.html">Do.Method</a></li>
<li><a href="../classes/Do.Prevent.html">Do.Prevent</a></li>
<li><a href="../classes/DOM.html">DOM</a></li>
<li><a href="../classes/DOMEventFacade.html">DOMEventFacade</a></li>
<li><a href="../classes/Drawing.html">Drawing</a></li>
<li><a href="../classes/Easing.html">Easing</a></li>
<li><a href="../classes/EditorBase.html">EditorBase</a></li>
<li><a href="../classes/EditorSelection.html">EditorSelection</a></li>
<li><a href="../classes/Ellipse.html">Ellipse</a></li>
<li><a href="../classes/EllipseGroup.html">EllipseGroup</a></li>
<li><a href="../classes/Escape.html">Escape</a></li>
<li><a href="../classes/Event.html">Event</a></li>
<li><a href="../classes/EventFacade.html">EventFacade</a></li>
<li><a href="../classes/EventHandle.html">EventHandle</a></li>
<li><a href="../classes/EventTarget.html">EventTarget</a></li>
<li><a href="../classes/ExecCommand.html">ExecCommand</a></li>
<li><a href="../classes/Features.html">Features</a></li>
<li><a href="../classes/File.html">File</a></li>
<li><a href="../classes/FileFlash.html">FileFlash</a></li>
<li><a href="../classes/FileHTML5.html">FileHTML5</a></li>
<li><a href="../classes/Fills.html">Fills</a></li>
<li><a href="../classes/Frame.html">Frame</a></li>
<li><a href="../classes/Get.html">Get</a></li>
<li><a href="../classes/Get.Transaction.html">Get.Transaction</a></li>
<li><a href="../classes/GetNodeJS.html">GetNodeJS</a></li>
<li><a href="../classes/Graph.html">Graph</a></li>
<li><a href="../classes/Graphic.html">Graphic</a></li>
<li><a href="../classes/GraphicBase.html">GraphicBase</a></li>
<li><a href="../classes/Gridlines.html">Gridlines</a></li>
<li><a href="../classes/GroupDiamond.html">GroupDiamond</a></li>
<li><a href="../classes/GroupRect.html">GroupRect</a></li>
<li><a href="../classes/Handlebars.html">Handlebars</a></li>
<li><a href="../classes/Highlight.html">Highlight</a></li>
<li><a href="../classes/Histogram.html">Histogram</a></li>
<li><a href="../classes/HistoryBase.html">HistoryBase</a></li>
<li><a href="../classes/HistoryHash.html">HistoryHash</a></li>
<li><a href="../classes/HistoryHTML5.html">HistoryHTML5</a></li>
<li><a href="../classes/HorizontalLegendLayout.html">HorizontalLegendLayout</a></li>
<li><a href="../classes/ImgLoadGroup.html">ImgLoadGroup</a></li>
<li><a href="../classes/ImgLoadImgObj.html">ImgLoadImgObj</a></li>
<li><a href="../classes/Intl.html">Intl</a></li>
<li><a href="../classes/IO.html">IO</a></li>
<li><a href="../classes/JSON.html">JSON</a></li>
<li><a href="../classes/JSONPRequest.html">JSONPRequest</a></li>
<li><a href="../classes/Lang.html">Lang</a></li>
<li><a href="../classes/LazyModelList.html">LazyModelList</a></li>
<li><a href="../classes/LeftAxisLayout.html">LeftAxisLayout</a></li>
<li><a href="../classes/Lines.html">Lines</a></li>
<li><a href="../classes/LineSeries.html">LineSeries</a></li>
<li><a href="../classes/Loader.html">Loader</a></li>
<li><a href="../classes/MarkerSeries.html">MarkerSeries</a></li>
<li><a href="../classes/Matrix.html">Matrix</a></li>
<li><a href="../classes/MatrixUtil.html">MatrixUtil</a></li>
<li><a href="../classes/Model.html">Model</a></li>
<li><a href="../classes/ModelList.html">ModelList</a></li>
<li><a href="../classes/ModelSync.REST.html">ModelSync.REST</a></li>
<li><a href="../classes/Node.html">Node</a></li>
<li><a href="../classes/NodeList.html">NodeList</a></li>
<li><a href="../classes/Number.html">Number</a></li>
<li><a href="../classes/NumericAxis.html">NumericAxis</a></li>
<li><a href="../classes/NumericAxisBase.html">NumericAxisBase</a></li>
<li><a href="../classes/NumericImpl.html">NumericImpl</a></li>
<li><a href="../classes/Object.html">Object</a></li>
<li><a href="../classes/OHLCSeries.html">OHLCSeries</a></li>
<li><a href="../classes/Overlay.html">Overlay</a></li>
<li><a href="../classes/Panel.html">Panel</a></li>
<li><a href="../classes/Parallel.html">Parallel</a></li>
<li><a href="../classes/Path.html">Path</a></li>
<li><a href="../classes/PieChart.html">PieChart</a></li>
<li><a href="../classes/PieSeries.html">PieSeries</a></li>
<li><a href="../classes/Pjax.html">Pjax</a></li>
<li><a href="../classes/PjaxBase.html">PjaxBase</a></li>
<li><a href="../classes/PjaxContent.html">PjaxContent</a></li>
<li><a href="../classes/Plots.html">Plots</a></li>
<li><a href="../classes/Plugin.Align.html">Plugin.Align</a></li>
<li><a href="../classes/Plugin.AutoComplete.html">Plugin.AutoComplete</a></li>
<li><a href="../classes/Plugin.Base.html">Plugin.Base</a></li>
<li><a href="../classes/Plugin.Button.html">Plugin.Button</a></li>
<li><a href="../classes/Plugin.Cache.html">Plugin.Cache</a></li>
<li><a href="../classes/Plugin.CalendarNavigator.html">Plugin.CalendarNavigator</a></li>
<li><a href="../classes/Plugin.ConsoleFilters.html">Plugin.ConsoleFilters</a></li>
<li><a href="../classes/Plugin.CreateLinkBase.html">Plugin.CreateLinkBase</a></li>
<li><a href="../classes/Plugin.DataTableDataSource.html">Plugin.DataTableDataSource</a></li>
<li><a href="../classes/Plugin.DDConstrained.html">Plugin.DDConstrained</a></li>
<li><a href="../classes/Plugin.DDNodeScroll.html">Plugin.DDNodeScroll</a></li>
<li><a href="../classes/Plugin.DDProxy.html">Plugin.DDProxy</a></li>
<li><a href="../classes/Plugin.DDWindowScroll.html">Plugin.DDWindowScroll</a></li>
<li><a href="../classes/Plugin.Drag.html">Plugin.Drag</a></li>
<li><a href="../classes/Plugin.Drop.html">Plugin.Drop</a></li>
<li><a href="../classes/Plugin.EditorBidi.html">Plugin.EditorBidi</a></li>
<li><a href="../classes/Plugin.EditorBR.html">Plugin.EditorBR</a></li>
<li><a href="../classes/Plugin.EditorLists.html">Plugin.EditorLists</a></li>
<li><a href="../classes/Plugin.EditorPara.html">Plugin.EditorPara</a></li>
<li><a href="../classes/Plugin.EditorParaBase.html">Plugin.EditorParaBase</a></li>
<li><a href="../classes/Plugin.EditorParaIE.html">Plugin.EditorParaIE</a></li>
<li><a href="../classes/Plugin.EditorTab.html">Plugin.EditorTab</a></li>
<li><a href="../classes/Plugin.ExecCommand.html">Plugin.ExecCommand</a></li>
<li><a href="../classes/Plugin.Flick.html">Plugin.Flick</a></li>
<li><a href="../classes/Plugin.Host.html">Plugin.Host</a></li>
<li><a href="../classes/plugin.NodeFocusManager.html">plugin.NodeFocusManager</a></li>
<li><a href="../classes/Plugin.NodeFX.html">Plugin.NodeFX</a></li>
<li><a href="../classes/plugin.NodeMenuNav.html">plugin.NodeMenuNav</a></li>
<li><a href="../classes/Plugin.Pjax.html">Plugin.Pjax</a></li>
<li><a href="../classes/Plugin.Resize.html">Plugin.Resize</a></li>
<li><a href="../classes/Plugin.ResizeConstrained.html">Plugin.ResizeConstrained</a></li>
<li><a href="../classes/Plugin.ResizeProxy.html">Plugin.ResizeProxy</a></li>
<li><a href="../classes/Plugin.ScrollInfo.html">Plugin.ScrollInfo</a></li>
<li><a href="../classes/Plugin.ScrollViewList.html">Plugin.ScrollViewList</a></li>
<li><a href="../classes/Plugin.ScrollViewPaginator.html">Plugin.ScrollViewPaginator</a></li>
<li><a href="../classes/Plugin.ScrollViewScrollbars.html">Plugin.ScrollViewScrollbars</a></li>
<li><a href="../classes/Plugin.Shim.html">Plugin.Shim</a></li>
<li><a href="../classes/Plugin.SortScroll.html">Plugin.SortScroll</a></li>
<li><a href="../classes/Plugin.Tree.Lazy.html">Plugin.Tree.Lazy</a></li>
<li><a href="../classes/Plugin.WidgetAnim.html">Plugin.WidgetAnim</a></li>
<li><a href="../classes/Pollable.html">Pollable</a></li>
<li><a href="../classes/Promise.html">Promise</a></li>
<li><a href="../classes/Promise.Resolver.html">Promise.Resolver</a></li>
<li><a href="../classes/QueryString.html">QueryString</a></li>
<li><a href="../classes/Queue.html">Queue</a></li>
<li><a href="../classes/RangeSeries.html">RangeSeries</a></li>
<li><a href="../classes/Record.html">Record</a></li>
<li><a href="../classes/Recordset.html">Recordset</a></li>
<li><a href="../classes/RecordsetFilter.html">RecordsetFilter</a></li>
<li><a href="../classes/RecordsetIndexer.html">RecordsetIndexer</a></li>
<li><a href="../classes/RecordsetSort.html">RecordsetSort</a></li>
<li><a href="../classes/Rect.html">Rect</a></li>
<li><a href="../classes/Renderer.html">Renderer</a></li>
<li><a href="../classes/Resize.html">Resize</a></li>
<li><a href="../classes/RightAxisLayout.html">RightAxisLayout</a></li>
<li><a href="../classes/Router.html">Router</a></li>
<li><a href="../classes/ScrollView.html">ScrollView</a></li>
<li><a href="../classes/Selector.html">Selector</a></li>
<li><a href="../classes/SeriesBase.html">SeriesBase</a></li>
<li><a href="../classes/Shape.html">Shape</a></li>
<li><a href="../classes/ShapeGroup.html">ShapeGroup</a></li>
<li><a href="../classes/Slider.html">Slider</a></li>
<li><a href="../classes/SliderBase.html">SliderBase</a></li>
<li><a href="../classes/SliderValueRange.html">SliderValueRange</a></li>
<li><a href="../classes/soon.html">soon</a></li>
<li><a href="../classes/Sortable.html">Sortable</a></li>
<li><a href="../classes/SplineSeries.html">SplineSeries</a></li>
<li><a href="../classes/StackedAreaSeries.html">StackedAreaSeries</a></li>
<li><a href="../classes/StackedAreaSplineSeries.html">StackedAreaSplineSeries</a></li>
<li><a href="../classes/StackedAxis.html">StackedAxis</a></li>
<li><a href="../classes/StackedAxisBase.html">StackedAxisBase</a></li>
<li><a href="../classes/StackedBarSeries.html">StackedBarSeries</a></li>
<li><a href="../classes/StackedColumnSeries.html">StackedColumnSeries</a></li>
<li><a href="../classes/StackedComboSeries.html">StackedComboSeries</a></li>
<li><a href="../classes/StackedComboSplineSeries.html">StackedComboSplineSeries</a></li>
<li><a href="../classes/StackedImpl.html">StackedImpl</a></li>
<li><a href="../classes/StackedLineSeries.html">StackedLineSeries</a></li>
<li><a href="../classes/StackedMarkerSeries.html">StackedMarkerSeries</a></li>
<li><a href="../classes/StackedSplineSeries.html">StackedSplineSeries</a></li>
<li><a href="../classes/StackingUtil.html">StackingUtil</a></li>
<li><a href="../classes/State.html">State</a></li>
<li><a href="../classes/StyleSheet.html">StyleSheet</a></li>
<li><a href="../classes/Subscriber.html">Subscriber</a></li>
<li><a href="../classes/SVGCircle.html">SVGCircle</a></li>
<li><a href="../classes/SVGDrawing.html">SVGDrawing</a></li>
<li><a href="../classes/SVGEllipse.html">SVGEllipse</a></li>
<li><a href="../classes/SVGGraphic.html">SVGGraphic</a></li>
<li><a href="../classes/SVGPath.html">SVGPath</a></li>
<li><a href="../classes/SVGPieSlice.html">SVGPieSlice</a></li>
<li><a href="../classes/SVGRect.html">SVGRect</a></li>
<li><a href="../classes/SVGShape.html">SVGShape</a></li>
<li><a href="../classes/SWF.html">SWF</a></li>
<li><a href="../classes/SWFDetect.html">SWFDetect</a></li>
<li><a href="../classes/SyntheticEvent.html">SyntheticEvent</a></li>
<li><a href="../classes/SyntheticEvent.Notifier.html">SyntheticEvent.Notifier</a></li>
<li><a href="../classes/SynthRegistry.html">SynthRegistry</a></li>
<li><a href="../classes/Tab.html">Tab</a></li>
<li><a href="../classes/TabView.html">TabView</a></li>
<li><a href="../classes/Template.html">Template</a></li>
<li><a href="../classes/Template.Micro.html">Template.Micro</a></li>
<li><a href="../classes/Test.ArrayAssert.html">Test.ArrayAssert</a></li>
<li><a href="../classes/Test.Assert.html">Test.Assert</a></li>
<li><a href="../classes/Test.AssertionError.html">Test.AssertionError</a></li>
<li><a href="../classes/Test.ComparisonFailure.html">Test.ComparisonFailure</a></li>
<li><a href="../classes/Test.Console.html">Test.Console</a></li>
<li><a href="../classes/Test.CoverageFormat.html">Test.CoverageFormat</a></li>
<li><a href="../classes/Test.DateAssert.html">Test.DateAssert</a></li>
<li><a href="../classes/Test.EventTarget.html">Test.EventTarget</a></li>
<li><a href="../classes/Test.Mock.html">Test.Mock</a></li>
<li><a href="../classes/Test.Mock.Value.html">Test.Mock.Value</a></li>
<li><a href="../classes/Test.ObjectAssert.html">Test.ObjectAssert</a></li>
<li><a href="../classes/Test.Reporter.html">Test.Reporter</a></li>
<li><a href="../classes/Test.Results.html">Test.Results</a></li>
<li><a href="../classes/Test.Runner.html">Test.Runner</a></li>
<li><a href="../classes/Test.ShouldError.html">Test.ShouldError</a></li>
<li><a href="../classes/Test.ShouldFail.html">Test.ShouldFail</a></li>
<li><a href="../classes/Test.TestCase.html">Test.TestCase</a></li>
<li><a href="../classes/Test.TestFormat.html">Test.TestFormat</a></li>
<li><a href="../classes/Test.TestNode.html">Test.TestNode</a></li>
<li><a href="../classes/Test.TestRunner.html">Test.TestRunner</a></li>
<li><a href="../classes/Test.TestSuite.html">Test.TestSuite</a></li>
<li><a href="../classes/Test.UnexpectedError.html">Test.UnexpectedError</a></li>
<li><a href="../classes/Test.UnexpectedValue.html">Test.UnexpectedValue</a></li>
<li><a href="../classes/Test.Wait.html">Test.Wait</a></li>
<li><a href="../classes/Text.AccentFold.html">Text.AccentFold</a></li>
<li><a href="../classes/Text.WordBreak.html">Text.WordBreak</a></li>
<li><a href="../classes/TimeAxis.html">TimeAxis</a></li>
<li><a href="../classes/TimeAxisBase.html">TimeAxisBase</a></li>
<li><a href="../classes/TimeImpl.html">TimeImpl</a></li>
<li><a href="../classes/ToggleButton.html">ToggleButton</a></li>
<li><a href="../classes/TopAxisLayout.html">TopAxisLayout</a></li>
<li><a href="../classes/Transition.html">Transition</a></li>
<li><a href="../classes/Tree.html">Tree</a></li>
<li><a href="../classes/Tree.Labelable.html">Tree.Labelable</a></li>
<li><a href="../classes/Tree.Node.html">Tree.Node</a></li>
<li><a href="../classes/Tree.Node.Labelable.html">Tree.Node.Labelable</a></li>
<li><a href="../classes/Tree.Node.Openable.html">Tree.Node.Openable</a></li>
<li><a href="../classes/Tree.Node.Selectable.html">Tree.Node.Selectable</a></li>
<li><a href="../classes/Tree.Node.Sortable.html">Tree.Node.Sortable</a></li>
<li><a href="../classes/Tree.Openable.html">Tree.Openable</a></li>
<li><a href="../classes/Tree.Selectable.html">Tree.Selectable</a></li>
<li><a href="../classes/Tree.Sortable.html">Tree.Sortable</a></li>
<li><a href="../classes/UA.html">UA</a></li>
<li><a href="../classes/Uploader.html">Uploader</a></li>
<li><a href="../classes/Uploader.Queue.html">Uploader.Queue</a></li>
<li><a href="../classes/UploaderFlash.html">UploaderFlash</a></li>
<li><a href="../classes/UploaderHTML5.html">UploaderHTML5</a></li>
<li><a href="../classes/ValueChange.html">ValueChange</a></li>
<li><a href="../classes/VerticalLegendLayout.html">VerticalLegendLayout</a></li>
<li><a href="../classes/View.html">View</a></li>
<li><a href="../classes/View.NodeMap.html">View.NodeMap</a></li>
<li><a href="../classes/VMLCircle.html">VMLCircle</a></li>
<li><a href="../classes/VMLDrawing.html">VMLDrawing</a></li>
<li><a href="../classes/VMLEllipse.html">VMLEllipse</a></li>
<li><a href="../classes/VMLGraphic.html">VMLGraphic</a></li>
<li><a href="../classes/VMLPath.html">VMLPath</a></li>
<li><a href="../classes/VMLPieSlice.html">VMLPieSlice</a></li>
<li><a href="../classes/VMLRect.html">VMLRect</a></li>
<li><a href="../classes/VMLShape.html">VMLShape</a></li>
<li><a href="../classes/Widget.html">Widget</a></li>
<li><a href="../classes/WidgetAutohide.html">WidgetAutohide</a></li>
<li><a href="../classes/WidgetButtons.html">WidgetButtons</a></li>
<li><a href="../classes/WidgetChild.html">WidgetChild</a></li>
<li><a href="../classes/WidgetModality.html">WidgetModality</a></li>
<li><a href="../classes/WidgetParent.html">WidgetParent</a></li>
<li><a href="../classes/WidgetPosition.html">WidgetPosition</a></li>
<li><a href="../classes/WidgetPositionAlign.html">WidgetPositionAlign</a></li>
<li><a href="../classes/WidgetPositionConstrain.html">WidgetPositionConstrain</a></li>
<li><a href="../classes/WidgetStack.html">WidgetStack</a></li>
<li><a href="../classes/WidgetStdMod.html">WidgetStdMod</a></li>
<li><a href="../classes/XML.html">XML</a></li>
<li><a href="../classes/YQL.html">YQL</a></li>
<li><a href="../classes/YQLRequest.html">YQLRequest</a></li>
<li><a href="../classes/YUI.html">YUI</a></li>
<li><a href="../classes/YUI~substitute.html">YUI~substitute</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="../modules/align-plugin.html">align-plugin</a></li>
<li><a href="../modules/anim.html">anim</a></li>
<li><a href="../modules/anim-base.html">anim-base</a></li>
<li><a href="../modules/anim-color.html">anim-color</a></li>
<li><a href="../modules/anim-curve.html">anim-curve</a></li>
<li><a href="../modules/anim-easing.html">anim-easing</a></li>
<li><a href="../modules/anim-node-plugin.html">anim-node-plugin</a></li>
<li><a href="../modules/anim-scroll.html">anim-scroll</a></li>
<li><a href="../modules/anim-shape.html">anim-shape</a></li>
<li><a href="../modules/anim-shape-transform.html">anim-shape-transform</a></li>
<li><a href="../modules/anim-xy.html">anim-xy</a></li>
<li><a href="../modules/app.html">app</a></li>
<li><a href="../modules/app-base.html">app-base</a></li>
<li><a href="../modules/app-content.html">app-content</a></li>
<li><a href="../modules/app-transitions.html">app-transitions</a></li>
<li><a href="../modules/app-transitions-native.html">app-transitions-native</a></li>
<li><a href="../modules/array-extras.html">array-extras</a></li>
<li><a href="../modules/array-invoke.html">array-invoke</a></li>
<li><a href="../modules/arraylist.html">arraylist</a></li>
<li><a href="../modules/arraylist-add.html">arraylist-add</a></li>
<li><a href="../modules/arraylist-filter.html">arraylist-filter</a></li>
<li><a href="../modules/arraysort.html">arraysort</a></li>
<li><a href="../modules/async-queue.html">async-queue</a></li>
<li><a href="../modules/attribute.html">attribute</a></li>
<li><a href="../modules/attribute-base.html">attribute-base</a></li>
<li><a href="../modules/attribute-complex.html">attribute-complex</a></li>
<li><a href="../modules/attribute-core.html">attribute-core</a></li>
<li><a href="../modules/attribute-extras.html">attribute-extras</a></li>
<li><a href="../modules/attribute-observable.html">attribute-observable</a></li>
<li><a href="../modules/autocomplete.html">autocomplete</a></li>
<li><a href="../modules/autocomplete-base.html">autocomplete-base</a></li>
<li><a href="../modules/autocomplete-filters.html">autocomplete-filters</a></li>
<li><a href="../modules/autocomplete-filters-accentfold.html">autocomplete-filters-accentfold</a></li>
<li><a href="../modules/autocomplete-highlighters.html">autocomplete-highlighters</a></li>
<li><a href="../modules/autocomplete-highlighters-accentfold.html">autocomplete-highlighters-accentfold</a></li>
<li><a href="../modules/autocomplete-list.html">autocomplete-list</a></li>
<li><a href="../modules/autocomplete-list-keys.html">autocomplete-list-keys</a></li>
<li><a href="../modules/autocomplete-plugin.html">autocomplete-plugin</a></li>
<li><a href="../modules/autocomplete-sources.html">autocomplete-sources</a></li>
<li><a href="../modules/axis.html">axis</a></li>
<li><a href="../modules/axis-base.html">axis-base</a></li>
<li><a href="../modules/axis-category.html">axis-category</a></li>
<li><a href="../modules/axis-category-base.html">axis-category-base</a></li>
<li><a href="../modules/axis-numeric.html">axis-numeric</a></li>
<li><a href="../modules/axis-numeric-base.html">axis-numeric-base</a></li>
<li><a href="../modules/axis-stacked.html">axis-stacked</a></li>
<li><a href="../modules/axis-stacked-base.html">axis-stacked-base</a></li>
<li><a href="../modules/axis-time.html">axis-time</a></li>
<li><a href="../modules/axis-time-base.html">axis-time-base</a></li>
<li><a href="../modules/base.html">base</a></li>
<li><a href="../modules/base-base.html">base-base</a></li>
<li><a href="../modules/base-build.html">base-build</a></li>
<li><a href="../modules/base-core.html">base-core</a></li>
<li><a href="../modules/base-observable.html">base-observable</a></li>
<li><a href="../modules/base-pluginhost.html">base-pluginhost</a></li>
<li><a href="../modules/button.html">button</a></li>
<li><a href="../modules/button-core.html">button-core</a></li>
<li><a href="../modules/button-group.html">button-group</a></li>
<li><a href="../modules/button-plugin.html">button-plugin</a></li>
<li><a href="../modules/cache.html">cache</a></li>
<li><a href="../modules/cache-base.html">cache-base</a></li>
<li><a href="../modules/cache-offline.html">cache-offline</a></li>
<li><a href="../modules/cache-plugin.html">cache-plugin</a></li>
<li><a href="../modules/calendar.html">calendar</a></li>
<li><a href="../modules/calendar-base.html">calendar-base</a></li>
<li><a href="../modules/calendarnavigator.html">calendarnavigator</a></li>
<li><a href="../modules/charts.html">charts</a></li>
<li><a href="../modules/charts-base.html">charts-base</a></li>
<li><a href="../modules/charts-legend.html">charts-legend</a></li>
<li><a href="../modules/classnamemanager.html">classnamemanager</a></li>
<li><a href="../modules/clickable-rail.html">clickable-rail</a></li>
<li><a href="../modules/collection.html">collection</a></li>
<li><a href="../modules/color.html">color</a></li>
<li><a href="../modules/color-base.html">color-base</a></li>
<li><a href="../modules/color-harmony.html">color-harmony</a></li>
<li><a href="../modules/color-hsl.html">color-hsl</a></li>
<li><a href="../modules/color-hsv.html">color-hsv</a></li>
<li><a href="../modules/console.html">console</a></li>
<li><a href="../modules/console-filters.html">console-filters</a></li>
<li><a href="../modules/cookie.html">cookie</a></li>
<li><a href="../modules/createlink-base.html">createlink-base</a></li>
<li><a href="../modules/dataschema.html">dataschema</a></li>
<li><a href="../modules/dataschema-array.html">dataschema-array</a></li>
<li><a href="../modules/dataschema-base.html">dataschema-base</a></li>
<li><a href="../modules/dataschema-json.html">dataschema-json</a></li>
<li><a href="../modules/dataschema-text.html">dataschema-text</a></li>
<li><a href="../modules/dataschema-xml.html">dataschema-xml</a></li>
<li><a href="../modules/datasource.html">datasource</a></li>
<li><a href="../modules/datasource-arrayschema.html">datasource-arrayschema</a></li>
<li><a href="../modules/datasource-cache.html">datasource-cache</a></li>
<li><a href="../modules/datasource-function.html">datasource-function</a></li>
<li><a href="../modules/datasource-get.html">datasource-get</a></li>
<li><a href="../modules/datasource-io.html">datasource-io</a></li>
<li><a href="../modules/datasource-jsonschema.html">datasource-jsonschema</a></li>
<li><a href="../modules/datasource-local.html">datasource-local</a></li>
<li><a href="../modules/datasource-polling.html">datasource-polling</a></li>
<li><a href="../modules/datasource-textschema.html">datasource-textschema</a></li>
<li><a href="../modules/datasource-xmlschema.html">datasource-xmlschema</a></li>
<li><a href="../modules/datatable.html">datatable</a></li>
<li><a href="../modules/datatable-base.html">datatable-base</a></li>
<li><a href="../modules/datatable-body.html">datatable-body</a></li>
<li><a href="../modules/datatable-column-widths.html">datatable-column-widths</a></li>
<li><a href="../modules/datatable-core.html">datatable-core</a></li>
<li><a href="../modules/datatable-datasource.html">datatable-datasource</a></li>
<li><a href="../modules/datatable-formatters.html">datatable-formatters</a></li>
<li><a href="../modules/datatable-head.html">datatable-head</a></li>
<li><a href="../modules/datatable-message.html">datatable-message</a></li>
<li><a href="../modules/datatable-mutable.html">datatable-mutable</a></li>
<li><a href="../modules/datatable-scroll.html">datatable-scroll</a></li>
<li><a href="../modules/datatable-sort.html">datatable-sort</a></li>
<li><a href="../modules/datatable-table.html">datatable-table</a></li>
<li><a href="../modules/datatype.html">datatype</a></li>
<li><a href="../modules/datatype-date.html">datatype-date</a></li>
<li><a href="../modules/datatype-date-format.html">datatype-date-format</a></li>
<li><a href="../modules/datatype-date-math.html">datatype-date-math</a></li>
<li><a href="../modules/datatype-date-parse.html">datatype-date-parse</a></li>
<li><a href="../modules/datatype-number.html">datatype-number</a></li>
<li><a href="../modules/datatype-number-format.html">datatype-number-format</a></li>
<li><a href="../modules/datatype-number-parse.html">datatype-number-parse</a></li>
<li><a href="../modules/datatype-xml.html">datatype-xml</a></li>
<li><a href="../modules/datatype-xml-format.html">datatype-xml-format</a></li>
<li><a href="../modules/datatype-xml-parse.html">datatype-xml-parse</a></li>
<li><a href="../modules/dd.html">dd</a></li>
<li><a href="../modules/dd-constrain.html">dd-constrain</a></li>
<li><a href="../modules/dd-ddm.html">dd-ddm</a></li>
<li><a href="../modules/dd-ddm-base.html">dd-ddm-base</a></li>
<li><a href="../modules/dd-ddm-drop.html">dd-ddm-drop</a></li>
<li><a href="../modules/dd-delegate.html">dd-delegate</a></li>
<li><a href="../modules/dd-drag.html">dd-drag</a></li>
<li><a href="../modules/dd-drop.html">dd-drop</a></li>
<li><a href="../modules/dd-drop-plugin.html">dd-drop-plugin</a></li>
<li><a href="../modules/dd-gestures.html">dd-gestures</a></li>
<li><a href="../modules/dd-plugin.html">dd-plugin</a></li>
<li><a href="../modules/dd-proxy.html">dd-proxy</a></li>
<li><a href="../modules/dd-scroll.html">dd-scroll</a></li>
<li><a href="../modules/dial.html">dial</a></li>
<li><a href="../modules/dom.html">dom</a></li>
<li><a href="../modules/dom-base.html">dom-base</a></li>
<li><a href="../modules/dom-screen.html">dom-screen</a></li>
<li><a href="../modules/dom-style.html">dom-style</a></li>
<li><a href="../modules/dump.html">dump</a></li>
<li><a href="../modules/editor.html">editor</a></li>
<li><a href="../modules/editor-base.html">editor-base</a></li>
<li><a href="../modules/editor-bidi.html">editor-bidi</a></li>
<li><a href="../modules/editor-br.html">editor-br</a></li>
<li><a href="../modules/editor-lists.html">editor-lists</a></li>
<li><a href="../modules/editor-para.html">editor-para</a></li>
<li><a href="../modules/editor-para-base.html">editor-para-base</a></li>
<li><a href="../modules/editor-para-ie.html">editor-para-ie</a></li>
<li><a href="../modules/editor-tab.html">editor-tab</a></li>
<li><a href="../modules/escape.html">escape</a></li>
<li><a href="../modules/event.html">event</a></li>
<li><a href="../modules/event-base.html">event-base</a></li>
<li><a href="../modules/event-contextmenu.html">event-contextmenu</a></li>
<li><a href="../modules/event-custom.html">event-custom</a></li>
<li><a href="../modules/event-custom-base.html">event-custom-base</a></li>
<li><a href="../modules/event-custom-complex.html">event-custom-complex</a></li>
<li><a href="../modules/event-delegate.html">event-delegate</a></li>
<li><a href="../modules/event-flick.html">event-flick</a></li>
<li><a href="../modules/event-focus.html">event-focus</a></li>
<li><a href="../modules/event-gestures.html">event-gestures</a></li>
<li><a href="../modules/event-hover.html">event-hover</a></li>
<li><a href="../modules/event-key.html">event-key</a></li>
<li><a href="../modules/event-mouseenter.html">event-mouseenter</a></li>
<li><a href="../modules/event-mousewheel.html">event-mousewheel</a></li>
<li><a href="../modules/event-move.html">event-move</a></li>
<li><a href="../modules/event-outside.html">event-outside</a></li>
<li><a href="../modules/event-resize.html">event-resize</a></li>
<li><a href="../modules/event-simulate.html">event-simulate</a></li>
<li><a href="../modules/event-synthetic.html">event-synthetic</a></li>
<li><a href="../modules/event-tap.html">event-tap</a></li>
<li><a href="../modules/event-touch.html">event-touch</a></li>
<li><a href="../modules/event-valuechange.html">event-valuechange</a></li>
<li><a href="../modules/exec-command.html">exec-command</a></li>
<li><a href="../modules/features.html">features</a></li>
<li><a href="../modules/file.html">file</a></li>
<li><a href="../modules/file-flash.html">file-flash</a></li>
<li><a href="../modules/file-html5.html">file-html5</a></li>
<li><a href="../modules/frame.html">frame</a></li>
<li><a href="../modules/gesture-simulate.html">gesture-simulate</a></li>
<li><a href="../modules/get.html">get</a></li>
<li><a href="../modules/get-nodejs.html">get-nodejs</a></li>
<li><a href="../modules/graphics.html">graphics</a></li>
<li><a href="../modules/graphics-group.html">graphics-group</a></li>
<li><a href="../modules/handlebars.html">handlebars</a></li>
<li><a href="../modules/handlebars-base.html">handlebars-base</a></li>
<li><a href="../modules/handlebars-compiler.html">handlebars-compiler</a></li>
<li><a href="../modules/highlight.html">highlight</a></li>
<li><a href="../modules/highlight-accentfold.html">highlight-accentfold</a></li>
<li><a href="../modules/highlight-base.html">highlight-base</a></li>
<li><a href="../modules/history.html">history</a></li>
<li><a href="../modules/history-base.html">history-base</a></li>
<li><a href="../modules/history-hash.html">history-hash</a></li>
<li><a href="../modules/history-hash-ie.html">history-hash-ie</a></li>
<li><a href="../modules/history-html5.html">history-html5</a></li>
<li><a href="../modules/imageloader.html">imageloader</a></li>
<li><a href="../modules/intl.html">intl</a></li>
<li><a href="../modules/io.html">io</a></li>
<li><a href="../modules/io-base.html">io-base</a></li>
<li><a href="../modules/io-form.html">io-form</a></li>
<li><a href="../modules/io-nodejs.html">io-nodejs</a></li>
<li><a href="../modules/io-queue.html">io-queue</a></li>
<li><a href="../modules/io-upload-iframe.html">io-upload-iframe</a></li>
<li><a href="../modules/io-xdr.html">io-xdr</a></li>
<li><a href="../modules/json.html">json</a></li>
<li><a href="../modules/json-parse.html">json-parse</a></li>
<li><a href="../modules/json-stringify.html">json-stringify</a></li>
<li><a href="../modules/jsonp.html">jsonp</a></li>
<li><a href="../modules/jsonp-url.html">jsonp-url</a></li>
<li><a href="../modules/lazy-model-list.html">lazy-model-list</a></li>
<li><a href="../modules/loader.html">loader</a></li>
<li><a href="../modules/loader-base.html">loader-base</a></li>
<li><a href="../modules/loader-yui3.html">loader-yui3</a></li>
<li><a href="../modules/matrix.html">matrix</a></li>
<li><a href="../modules/model.html">model</a></li>
<li><a href="../modules/model-list.html">model-list</a></li>
<li><a href="../modules/model-sync-rest.html">model-sync-rest</a></li>
<li><a href="../modules/node.html">node</a></li>
<li><a href="../modules/node-base.html">node-base</a></li>
<li><a href="../modules/node-core.html">node-core</a></li>
<li><a href="../modules/node-data.html">node-data</a></li>
<li><a href="../modules/node-event-delegate.html">node-event-delegate</a></li>
<li><a href="../modules/node-event-html5.html">node-event-html5</a></li>
<li><a href="../modules/node-event-simulate.html">node-event-simulate</a></li>
<li><a href="../modules/node-flick.html">node-flick</a></li>
<li><a href="../modules/node-focusmanager.html">node-focusmanager</a></li>
<li><a href="../modules/node-load.html">node-load</a></li>
<li><a href="../modules/node-menunav.html">node-menunav</a></li>
<li><a href="../modules/node-pluginhost.html">node-pluginhost</a></li>
<li><a href="../modules/node-screen.html">node-screen</a></li>
<li><a href="../modules/node-scroll-info.html">node-scroll-info</a></li>
<li><a href="../modules/node-style.html">node-style</a></li>
<li><a href="../modules/oop.html">oop</a></li>
<li><a href="../modules/overlay.html">overlay</a></li>
<li><a href="../modules/panel.html">panel</a></li>
<li><a href="../modules/parallel.html">parallel</a></li>
<li><a href="../modules/pjax.html">pjax</a></li>
<li><a href="../modules/pjax-base.html">pjax-base</a></li>
<li><a href="../modules/pjax-content.html">pjax-content</a></li>
<li><a href="../modules/pjax-plugin.html">pjax-plugin</a></li>
<li><a href="../modules/plugin.html">plugin</a></li>
<li><a href="../modules/pluginhost.html">pluginhost</a></li>
<li><a href="../modules/pluginhost-base.html">pluginhost-base</a></li>
<li><a href="../modules/pluginhost-config.html">pluginhost-config</a></li>
<li><a href="../modules/promise.html">promise</a></li>
<li><a href="../modules/querystring.html">querystring</a></li>
<li><a href="../modules/querystring-parse.html">querystring-parse</a></li>
<li><a href="../modules/querystring-parse-simple.html">querystring-parse-simple</a></li>
<li><a href="../modules/querystring-stringify.html">querystring-stringify</a></li>
<li><a href="../modules/querystring-stringify-simple.html">querystring-stringify-simple</a></li>
<li><a href="../modules/queue-promote.html">queue-promote</a></li>
<li><a href="../modules/range-slider.html">range-slider</a></li>
<li><a href="../modules/recordset.html">recordset</a></li>
<li><a href="../modules/recordset-base.html">recordset-base</a></li>
<li><a href="../modules/recordset-filter.html">recordset-filter</a></li>
<li><a href="../modules/recordset-indexer.html">recordset-indexer</a></li>
<li><a href="../modules/recordset-sort.html">recordset-sort</a></li>
<li><a href="../modules/resize.html">resize</a></li>
<li><a href="../modules/resize-contrain.html">resize-contrain</a></li>
<li><a href="../modules/resize-plugin.html">resize-plugin</a></li>
<li><a href="../modules/resize-proxy.html">resize-proxy</a></li>
<li><a href="../modules/rollup.html">rollup</a></li>
<li><a href="../modules/router.html">router</a></li>
<li><a href="../modules/scrollview.html">scrollview</a></li>
<li><a href="../modules/scrollview-base.html">scrollview-base</a></li>
<li><a href="../modules/scrollview-base-ie.html">scrollview-base-ie</a></li>
<li><a href="../modules/scrollview-list.html">scrollview-list</a></li>
<li><a href="../modules/scrollview-paginator.html">scrollview-paginator</a></li>
<li><a href="../modules/scrollview-scrollbars.html">scrollview-scrollbars</a></li>
<li><a href="../modules/selection.html">selection</a></li>
<li><a href="../modules/selector-css2.html">selector-css2</a></li>
<li><a href="../modules/selector-css3.html">selector-css3</a></li>
<li><a href="../modules/selector-native.html">selector-native</a></li>
<li><a href="../modules/series-area.html">series-area</a></li>
<li><a href="../modules/series-area-stacked.html">series-area-stacked</a></li>
<li><a href="../modules/series-areaspline.html">series-areaspline</a></li>
<li><a href="../modules/series-areaspline-stacked.html">series-areaspline-stacked</a></li>
<li><a href="../modules/series-bar.html">series-bar</a></li>
<li><a href="../modules/series-bar-stacked.html">series-bar-stacked</a></li>
<li><a href="../modules/series-base.html">series-base</a></li>
<li><a href="../modules/series-candlestick.html">series-candlestick</a></li>
<li><a href="../modules/series-cartesian.html">series-cartesian</a></li>
<li><a href="../modules/series-column.html">series-column</a></li>
<li><a href="../modules/series-column-stacked.html">series-column-stacked</a></li>
<li><a href="../modules/series-combo.html">series-combo</a></li>
<li><a href="../modules/series-combo-stacked.html">series-combo-stacked</a></li>
<li><a href="../modules/series-combospline.html">series-combospline</a></li>
<li><a href="../modules/series-combospline-stacked.html">series-combospline-stacked</a></li>
<li><a href="../modules/series-curve-util.html">series-curve-util</a></li>
<li><a href="../modules/series-fill-util.html">series-fill-util</a></li>
<li><a href="../modules/series-histogram.html">series-histogram</a></li>
<li><a href="../modules/series-line.html">series-line</a></li>
<li><a href="../modules/series-line-stacked.html">series-line-stacked</a></li>
<li><a href="../modules/series-line-util.html">series-line-util</a></li>
<li><a href="../modules/series-marker.html">series-marker</a></li>
<li><a href="../modules/series-marker-stacked.html">series-marker-stacked</a></li>
<li><a href="../modules/series-ohlc.html">series-ohlc</a></li>
<li><a href="../modules/series-pie.html">series-pie</a></li>
<li><a href="../modules/series-plot-util.html">series-plot-util</a></li>
<li><a href="../modules/series-range.html">series-range</a></li>
<li><a href="../modules/series-spline.html">series-spline</a></li>
<li><a href="../modules/series-spline-stacked.html">series-spline-stacked</a></li>
<li><a href="../modules/series-stacked.html">series-stacked</a></li>
<li><a href="../modules/shim-plugin.html">shim-plugin</a></li>
<li><a href="../modules/slider.html">slider</a></li>
<li><a href="../modules/slider-base.html">slider-base</a></li>
<li><a href="../modules/slider-value-range.html">slider-value-range</a></li>
<li><a href="../modules/sortable.html">sortable</a></li>
<li><a href="../modules/sortable-scroll.html">sortable-scroll</a></li>
<li><a href="../modules/stylesheet.html">stylesheet</a></li>
<li><a href="../modules/substitute.html">substitute</a></li>
<li><a href="../modules/swf.html">swf</a></li>
<li><a href="../modules/swfdetect.html">swfdetect</a></li>
<li><a href="../modules/tabview.html">tabview</a></li>
<li><a href="../modules/template.html">template</a></li>
<li><a href="../modules/template-base.html">template-base</a></li>
<li><a href="../modules/template-micro.html">template-micro</a></li>
<li><a href="../modules/test.html">test</a></li>
<li><a href="../modules/test-console.html">test-console</a></li>
<li><a href="../modules/text.html">text</a></li>
<li><a href="../modules/text-accentfold.html">text-accentfold</a></li>
<li><a href="../modules/text-wordbreak.html">text-wordbreak</a></li>
<li><a href="../modules/timers.html">timers</a></li>
<li><a href="../modules/transition.html">transition</a></li>
<li><a href="../modules/transition-timer.html">transition-timer</a></li>
<li><a href="../modules/tree.html">tree</a></li>
<li><a href="../modules/tree-labelable.html">tree-labelable</a></li>
<li><a href="../modules/tree-lazy.html">tree-lazy</a></li>
<li><a href="../modules/tree-node.html">tree-node</a></li>
<li><a href="../modules/tree-openable.html">tree-openable</a></li>
<li><a href="../modules/tree-selectable.html">tree-selectable</a></li>
<li><a href="../modules/tree-sortable.html">tree-sortable</a></li>
<li><a href="../modules/uploader.html">uploader</a></li>
<li><a href="../modules/uploader-flash.html">uploader-flash</a></li>
<li><a href="../modules/uploader-html5.html">uploader-html5</a></li>
<li><a href="../modules/uploader-queue.html">uploader-queue</a></li>
<li><a href="../modules/view.html">view</a></li>
<li><a href="../modules/view-node-map.html">view-node-map</a></li>
<li><a href="../modules/widget.html">widget</a></li>
<li><a href="../modules/widget-anim.html">widget-anim</a></li>
<li><a href="../modules/widget-autohide.html">widget-autohide</a></li>
<li><a href="../modules/widget-base.html">widget-base</a></li>
<li><a href="../modules/widget-base-ie.html">widget-base-ie</a></li>
<li><a href="../modules/widget-buttons.html">widget-buttons</a></li>
<li><a href="../modules/widget-child.html">widget-child</a></li>
<li><a href="../modules/widget-htmlparser.html">widget-htmlparser</a></li>
<li><a href="../modules/widget-locale.html">widget-locale</a></li>
<li><a href="../modules/widget-modality.html">widget-modality</a></li>
<li><a href="../modules/widget-parent.html">widget-parent</a></li>
<li><a href="../modules/widget-position.html">widget-position</a></li>
<li><a href="../modules/widget-position-align.html">widget-position-align</a></li>
<li><a href="../modules/widget-position-constrain.html">widget-position-constrain</a></li>
<li><a href="../modules/widget-skin.html">widget-skin</a></li>
<li><a href="../modules/widget-stack.html">widget-stack</a></li>
<li><a href="../modules/widget-stdmod.html">widget-stdmod</a></li>
<li><a href="../modules/widget-uievents.html">widget-uievents</a></li>
<li><a href="../modules/yql.html">yql</a></li>
<li><a href="../modules/yql-jsonp.html">yql-jsonp</a></li>
<li><a href="../modules/yql-nodejs.html">yql-nodejs</a></li>
<li><a href="../modules/yql-winjs.html">yql-winjs</a></li>
<li><a href="../modules/yui.html">yui</a></li>
<li><a href="../modules/yui-base.html">yui-base</a></li>
<li><a href="../modules/yui-later.html">yui-later</a></li>
<li><a href="../modules/yui-log.html">yui-log</a></li>
<li><a href="../modules/yui-throttle.html">yui-throttle</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="yui3-u-3-4">
<div id="api-options">
Show:
<label for="api-show-inherited">
<input type="checkbox" id="api-show-inherited" checked>
Inherited
</label>
<label for="api-show-protected">
<input type="checkbox" id="api-show-protected">
Protected
</label>
<label for="api-show-private">
<input type="checkbox" id="api-show-private">
Private
</label>
<label for="api-show-deprecated">
<input type="checkbox" id="api-show-deprecated">
Deprecated
</label>
</div>
<div class="apidocs">
<div id="docs-main">
<div class="content">
<h1>IO Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="../files/io_js_io-base.js.html#l18"><code>io/js/io-base.js:18</code></a>
</div>
Module: <a href="../modules/io-base.html">io-base</a><br>
Parent Module: <a href="../modules/io.html">io</a>
</div>
<div class="box intro">
<p>The IO class is a utility that brokers HTTP requests through a simplified
interface. Specifically, it allows JavaScript to make HTTP requests to
a resource without a page reload. The underlying transport for making
same-domain requests is the XMLHttpRequest object. IO can also use
Flash, if specified as a transport, for cross-domain requests.</p>
</div>
<div class="constructor">
<h2>Constructor</h2>
<div id="method_IO" class="method item">
<h3 class="name"><code>IO</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l18"><code>io/js/io-base.js:18</code></a>
</p>
</div>
<div class="description">
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Object of EventTarget's publish method configurations
used to configure IO's events.</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="classdocs" class="tabview">
<ul class="api-class-tabs">
<li class="api-class-tab index"><a href="#index">Index</a></li>
<li class="api-class-tab methods"><a href="#methods">Methods</a></li>
<li class="api-class-tab properties"><a href="#properties">Properties</a></li>
<li class="api-class-tab events"><a href="#events">Events</a></li>
</ul>
<div>
<div id="index" class="api-class-tabpanel index">
<h2 class="off-left">Item Index</h2>
<div class="index-section methods">
<h3>Methods</h3>
<ul class="index-list methods">
<li class="index-item method private">
<a href="#method__abort">_abort</a>
</li>
<li class="index-item method private">
<a href="#method__abort">_abort</a>
</li>
<li class="index-item method private">
<a href="#method__cFrame">_cFrame</a>
</li>
<li class="index-item method private">
<a href="#method__clearTimeout">_clearTimeout</a>
</li>
<li class="index-item method private">
<a href="#method__clearUploadTimeout">_clearUploadTimeout</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__concat">_concat</a>
</li>
<li class="index-item method private">
<a href="#method__create">_create</a>
</li>
<li class="index-item method private">
<a href="#method__data">_data</a>
</li>
<li class="index-item method private">
<a href="#method__dFrame">_dFrame</a>
</li>
<li class="index-item method private">
<a href="#method__evt">_evt</a>
</li>
<li class="index-item method private">
<a href="#method__ieEvt">_ieEvt</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__isInProgress">_isInProgress</a>
</li>
<li class="index-item method private">
<a href="#method__qShift">_qShift</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__removeData">_removeData</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__resetAttrs">_resetAttrs</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__result">_result</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__retry">_retry</a>
</li>
<li class="index-item method private">
<a href="#method__rS">_rS</a>
</li>
<li class="index-item method private">
<a href="#method__serialize">_serialize</a>
</li>
<li class="index-item method private">
<a href="#method__setAttrs">_setAttrs</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__setHeaders">_setHeaders</a>
</li>
<li class="index-item method private">
<a href="#method__size">_size</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__startTimeout">_startTimeout</a>
</li>
<li class="index-item method private">
<a href="#method__startUploadTimeout">_startUploadTimeout</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__stop">_stop</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__swf">_swf</a>
</li>
<li class="index-item method private">
<a href="#method__upload">_upload</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__uploadComplete">_uploadComplete</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method__xdrReady">_xdrReady</a>
</li>
<li class="index-item method private">
<a href="#method_appendData">appendData</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_complete">complete</a>
</li>
<li class="index-item method">
<a href="#method_empty">empty</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_end">end</a>
</li>
<li class="index-item method">
<a href="#method_error">error</a>
</li>
<li class="index-item method">
<a href="#method_failure">failure</a>
</li>
<li class="index-item method protected">
<a href="#method_flatten">flatten</a>
</li>
<li class="index-item method">
<a href="#method_load">load</a>
</li>
<li class="index-item method">
<a href="#method_progress">progress</a>
</li>
<li class="index-item method">
<a href="#method_promote">promote</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_queue">queue</a>
<span class="flag static">static</span>
</li>
<li class="index-item method private">
<a href="#method_remove">remove</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_request">request</a>
<span class="flag static">static</span>
</li>
<li class="index-item method public">
<a href="#method_send">send</a>
</li>
<li class="index-item method">
<a href="#method_setHeader">setHeader</a>
</li>
<li class="index-item method">
<a href="#method_start">start</a>
</li>
<li class="index-item method">
<a href="#method_stringify">stringify</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_success">success</a>
</li>
<li class="index-item method">
<a href="#method_transport">transport</a>
</li>
<li class="index-item method">
<a href="#method_transports.nodejs">transports.nodejs</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_xdr">xdr</a>
</li>
<li class="index-item method protected">
<a href="#method_xdrReady">xdrReady</a>
<span class="flag static">static</span>
</li>
<li class="index-item method">
<a href="#method_xdrResponse">xdrResponse</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property private">
<a href="#property__cB">_cB</a>
</li>
<li class="index-item property private">
<a href="#property__headers">_headers</a>
</li>
<li class="index-item property private">
<a href="#property__id">_id</a>
</li>
<li class="index-item property private">
<a href="#property__q">_q</a>
<span class="flag static">static</span>
</li>
<li class="index-item property private">
<a href="#property__qState">_qState</a>
<span class="flag static">static</span>
</li>
<li class="index-item property private">
<a href="#property__rS">_rS</a>
</li>
<li class="index-item property private">
<a href="#property__timeout">_timeout</a>
</li>
<li class="index-item property private">
<a href="#property__transport">_transport</a>
</li>
<li class="index-item property">
<a href="#property_delay">delay</a>
<span class="flag static">static</span>
</li>
</ul>
</div>
<div class="index-section events">
<h3>Events</h3>
<ul class="index-list events">
<li class="index-item event">
<a href="#event_io:complete">io:complete</a>
</li>
<li class="index-item event">
<a href="#event_io:end">io:end</a>
</li>
<li class="index-item event">
<a href="#event_io:failure">io:failure</a>
</li>
<li class="index-item event">
<a href="#event_io:progress">io:progress</a>
</li>
<li class="index-item event">
<a href="#event_io:start">io:start</a>
</li>
<li class="index-item event">
<a href="#event_io:success">io:success</a>
</li>
<li class="index-item event">
<a href="#event_io:xdrReady">io:xdrReady</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method__abort" class="method item private">
<h3 class="name"><code>_abort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l91"><code>io/js/io-xdr.js:91</code></a>
</p>
</div>
<div class="description">
<p>Method for intiating an XDR transaction abort.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>Transaction object generated by _create() in io-base.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>configuration object for the transaction.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__abort" class="method item private">
<h3 class="name"><code>_abort</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>type</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l516"><code>io/js/io-base.js:516</code></a>
</p>
</div>
<div class="description">
<p>Terminates a transaction due to an explicit abort or timeout.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">type</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Identifies timed out or aborted transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__cFrame" class="method item private">
<h3 class="name"><code>_cFrame</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
<li class="arg">
<code>io</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l15"><code>io/js/io-upload-iframe.js:15</code></a>
</p>
</div>
<div class="description">
<p>Creates the iframe transported used in file upload
transactions, and binds the response event handler.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object passed to YUI.io().</p>
</div>
</li>
<li class="param">
<code class="param-name">io</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
</li>
</ul>
</div>
</div>
<div id="method__clearTimeout" class="method item private">
<h3 class="name"><code>_clearTimeout</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l451"><code>io/js/io-base.js:451</code></a>
</p>
</div>
<div class="description">
<p>Clears the timeout interval started by _startTimeout().</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>Transaction id.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__clearUploadTimeout" class="method item private">
<h3 class="name"><code>_clearUploadTimeout</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l159"><code>io/js/io-upload-iframe.js:159</code></a>
</p>
</div>
<div class="description">
<p>Clears the timeout interval started by _startUploadTimeout().</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>Transaction ID.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__concat" class="method item private">
<h3 class="name"><code>_concat</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>data</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l386"><code>io/js/io-base.js:386</code></a>
</p>
</div>
<div class="description">
<p>Method that concatenates string data for HTTP GET transactions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>URI or root data.</p>
</div>
</li>
<li class="param">
<code class="param-name">data</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Data to be concatenated onto URI.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
</div>
</div>
</div>
<div id="method__create" class="method item private">
<h3 class="name"><code>_create</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>cfg</code>
</li>
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l94"><code>io/js/io-base.js:94</code></a>
</p>
</div>
<div class="description">
<p>Method that creates a unique transaction object for each request.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">cfg</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object subset to determine if
the transaction is an XDR or file upload,
requiring an alternate transport.</p>
</div>
</li>
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Transaction id</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
The transaction object
</div>
</div>
</div>
<div id="method__data" class="method item private">
<h3 class="name"><code>_data</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>u</code>
</li>
<li class="arg">
<code>d</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l68"><code>io/js/io-xdr.js:68</code></a>
</p>
</div>
<div class="description">
<p>Creates a response object for XDR transactions, for success
and failure cases.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>Transaction object generated by _create() in io-base.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">u</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<ul>
<li>Configuration xdr.use.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">d</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<ul>
<li>Configuration xdr.dataType.</li>
</ul>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
</div>
</div>
</div>
<div id="method__dFrame" class="method item private">
<h3 class="name"><code>_dFrame</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l35"><code>io/js/io-upload-iframe.js:35</code></a>
</p>
</div>
<div class="description">
<p>Removes the iframe transport used in the file upload
transaction.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>The transaction ID used in the iframe's creation.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__evt" class="method item private">
<h3 class="name"><code>_evt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>eventName</code>
</li>
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l170"><code>io/js/io-base.js:170</code></a>
</p>
</div>
<div class="description">
<p>Method for creating and firing events.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">eventName</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Event to be published.</p>
</div>
</li>
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration data subset for event subscription.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__ieEvt" class="method item private">
<h3 class="name"><code>_ieEvt</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l126"><code>io/js/io-xdr.js:126</code></a>
</p>
</div>
<div class="description">
<p>Sets event handlers for XDomainRequest transactions.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>Transaction object generated by _create() in io-base.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>configuration object for the transaction.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__isInProgress" class="method item private">
<h3 class="name"><code>_isInProgress</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l103"><code>io/js/io-xdr.js:103</code></a>
</p>
</div>
<div class="description">
<p>Method for determining if an XDR transaction has completed
and all data are received.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>Transaction object generated by _create() in io-base.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__qShift" class="method item private">
<h3 class="name"><code>_qShift</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l35"><code>io/js/io-queue.js:35</code></a>
</p>
</div>
<div class="description">
<p>Method Process the first transaction from the
queue in FIFO order.</p>
</div>
</div>
<div id="method__removeData" class="method item private">
<h3 class="name"><code>_removeData</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l83"><code>io/js/io-upload-iframe.js:83</code></a>
</p>
</div>
<div class="description">
<p>Removes the custom fields created to pass additional POST
data, along with the HTML form fields.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>HTML form object.</p>
</div>
</li>
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>HTML form fields created from configuration.data.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__resetAttrs" class="method item private">
<h3 class="name"><code>_resetAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
<li class="arg">
<code>a</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l117"><code>io/js/io-upload-iframe.js:117</code></a>
</p>
</div>
<div class="description">
<p>Reset the HTML form attributes to their original values.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>HTML form object.</p>
</div>
</li>
<li class="param">
<code class="param-name">a</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Object of original attributes.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__result" class="method item private">
<h3 class="name"><code>_result</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l463"><code>io/js/io-base.js:463</code></a>
</p>
</div>
<div class="description">
<p>Method that determines if a transaction response qualifies as success
or failure, based on the response HTTP status code, and fires the
appropriate success or failure events.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object passed to io().</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__retry" class="method item private">
<h3 class="name"><code>_retry</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l370"><code>io/js/io-base.js:370</code></a>
</p>
</div>
<div class="description">
<p>Retry an XDR transaction, using the Flash tranport, if the native
transport fails.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Qualified path to transaction resource.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__rS" class="method item private">
<h3 class="name"><code>_rS</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l492"><code>io/js/io-base.js:492</code></a>
</p>
</div>
<div class="description">
<p>Event handler bound to onreadystatechange.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object passed to YUI.io().</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__serialize" class="method item private">
<h3 class="name"><code>_serialize</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>c</code>
</li>
<li class="arg">
<code>s</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-form.html">io-form</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-form.js.html#l36"><code>io/js/io-form.js:36</code></a>
</p>
</div>
<div class="description">
<p>Enumerate through an HTML form's elements collection
and return a string comprised of key-value pairs.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
</div>
<ul class="params-list">
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Element</span>
<div class="param-description">
<p>YUI form node or HTML form id</p>
</div>
</li>
<li class="param">
<code class="param-name">useDisabled</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<div class="param-description">
<p><code>true</code> to include disabled fields</p>
</div>
</li>
</ul>
</li>
<li class="param">
<code class="param-name">s</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Key-value data defined in the configuration object.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
</div>
</div>
</div>
<div id="method__setAttrs" class="method item private">
<h3 class="name"><code>_setAttrs</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
<li class="arg">
<code>id</code>
</li>
<li class="arg">
<code>uri</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l100"><code>io/js/io-upload-iframe.js:100</code></a>
</p>
</div>
<div class="description">
<p>Sets the appropriate attributes and values to the HTML
form, in preparation of a file upload transaction.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>HTML form object.</p>
</div>
</li>
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The Transaction ID.</p>
</div>
</li>
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Qualified path to transaction resource.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__setHeaders" class="method item private">
<h3 class="name"><code>_setHeaders</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>headers</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l416"><code>io/js/io-base.js:416</code></a>
</p>
</div>
<div class="description">
<p>Method that sets all HTTP headers to be sent in a transaction.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>XHR instance for the specific transaction.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">headers</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>HTTP headers for the specific transaction, as
defined in the configuration object passed to YUI.io().</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__size" class="method item private">
<h3 class="name"><code>_size</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l144"><code>io/js/io-queue.js:144</code></a>
</p>
</div>
<div class="description">
<p>Method to query the current size of the queue.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>:
</div>
</div>
</div>
<div id="method__startTimeout" class="method item private">
<h3 class="name"><code>_startTimeout</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>timeout</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l434"><code>io/js/io-base.js:434</code></a>
</p>
</div>
<div class="description">
<p>Starts timeout count if the configuration object has a defined
timeout property.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">timeout</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Timeout in milliseconds.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__startUploadTimeout" class="method item private">
<h3 class="name"><code>_startUploadTimeout</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l136"><code>io/js/io-upload-iframe.js:136</code></a>
</p>
</div>
<div class="description">
<p>Starts timeout count if the configuration object
has a defined timeout property.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create().</p>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object passed to YUI.io().</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__stop" class="method item private">
<h3 class="name"><code>_stop</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l130"><code>io/js/io-queue.js:130</code></a>
</p>
</div>
<div class="description">
<p>Method for setting queue processing to inactive.
Transaction requests to YUI.io.queue() will be stored in the queue, but
not processed until the queue is reset to "active".</p>
</div>
</div>
<div id="method__swf" class="method item private">
<h3 class="name"><code>_swf</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>yid</code>
</li>
<li class="arg">
<code>yid</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l46"><code>io/js/io-xdr.js:46</code></a>
</p>
</div>
<div class="description">
<p>Method that creates the Flash transport swf.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<ul>
<li>location of io.swf.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">yid</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<ul>
<li>YUI sandbox id.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">yid</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<ul>
<li>IO instance id.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method__upload" class="method item private">
<h3 class="name"><code>_upload</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l217"><code>io/js/io-upload-iframe.js:217</code></a>
</p>
</div>
<div class="description">
<p>Uploads HTML form data, inclusive of files/attachments,
using the iframe created in _create to facilitate the transaction.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The transaction object</p>
</div>
</li>
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Qualified path to transaction resource.</p>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__uploadComplete" class="method item private">
<h3 class="name"><code>_uploadComplete</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l173"><code>io/js/io-upload-iframe.js:173</code></a>
</p>
</div>
<div class="description">
<p>Bound to the iframe's Load event and processes
the response data.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The transaction object</p>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method__xdrReady" class="method item private">
<h3 class="name"><code>_xdrReady</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>yid</code>
</li>
<li class="arg">
<code>uid</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l251"><code>io/js/io-xdr.js:251</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:xdrReady"</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">yid</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>YUI sandbox id.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">uid</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>IO instance id.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_appendData" class="method item private">
<h3 class="name"><code>appendData</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>f</code>
</li>
<li class="arg">
<code>s</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>
</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-upload-iframe.html">io-upload-iframe</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-upload-iframe.js.html#l50"><code>io/js/io-upload-iframe.js:50</code></a>
</p>
</div>
<div class="description">
<p>Parses the POST data object and creates hidden form elements
for each key-value, and appends them to the HTML form object.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">f</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>HTML form object.</p>
</div>
</li>
<li class="param">
<code class="param-name">s</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>The key-value POST data.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external" target="_blank">Array</a></span>:
o Array of created fields.
</div>
</div>
</div>
<div id="method_complete" class="method item">
<h3 class="name"><code>complete</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l248"><code>io/js/io-base.js:248</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:complete" and creates, fires a
transaction-specific "complete" event, if config.on.complete is
defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_empty" class="method item">
<h3 class="name"><code>empty</code></h3>
<span class="paren">()</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l108"><code>io/js/io-queue.js:108</code></a>
</p>
<p>Available since 3.7.3</p>
</div>
<div class="description">
<p>Method for cancel all pending transaction from
the queue.</p>
</div>
</div>
<div id="method_end" class="method item">
<h3 class="name"><code>end</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l267"><code>io/js/io-base.js:267</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:end" and creates, fires a transaction-specific "end"
event, if config.on.end is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_error" class="method item">
<h3 class="name"><code>error</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>error</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l355"><code>io/js/io-base.js:355</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:failure" and creates, fires a transaction-specific
"failure" event -- for XMLHttpRequest file upload -- if
config.on.failure is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">error</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>event.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_failure" class="method item">
<h3 class="name"><code>failure</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l302"><code>io/js/io-base.js:302</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:failure" and creates, fires a transaction-specific
"failure" event, if config.on.failure is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_flatten" class="method item protected">
<h3 class="name"><code>flatten</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag protected">protected</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-nodejs.html">io-nodejs</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-nodejs.js.html#l23"><code>io/js/io-nodejs.js:23</code></a>
</p>
</div>
<div class="description">
<p>Flatten headers object</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>The headers object</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
The flattened headers object
</div>
</div>
</div>
<div id="method_load" class="method item">
<h3 class="name"><code>load</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>load</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l340"><code>io/js/io-base.js:340</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:complete" and creates, fires a transaction-specific
"complete" event -- for XMLHttpRequest file upload -- if
config.on.complete is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">load</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>event.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_progress" class="method item">
<h3 class="name"><code>progress</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>progress</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l320"><code>io/js/io-base.js:320</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:progress" and creates, fires a transaction-specific
"progress" event -- for XMLHttpRequest file upload -- if
config.on.progress is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">progress</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>event.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_promote" class="method item">
<h3 class="name"><code>promote</code></h3>
<span class="paren">()</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l86"><code>io/js/io-queue.js:86</code></a>
</p>
</div>
<div class="description">
<p>Method for promoting a transaction to the top of the queue.</p>
</div>
</div>
<div id="method_queue" class="method item">
<h3 class="name"><code>queue</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l52"><code>io/js/io-queue.js:52</code></a>
</p>
</div>
<div class="description">
<p>Method for queueing a transaction before the request is sent to the
resource, to ensure sequential processing.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
</div>
</div>
</div>
<div id="method_remove" class="method item private">
<h3 class="name"><code>remove</code></h3>
<span class="paren">()</span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l96"><code>io/js/io-queue.js:96</code></a>
</p>
</div>
<div class="description">
<p>Method for removing a specific, pending transaction from
the queue.</p>
</div>
</div>
<div id="method_request" class="method item">
<h3 class="name"><code>request</code></h3>
<span class="paren">()</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-nodejs.html">io-nodejs</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-nodejs.js.html#l7"><code>io/js/io-nodejs.js:7</code></a>
</p>
</div>
<div class="description">
<p>Passthru to the NodeJS <a href="https://github.com/mikeal/request">request</a> module.
This method is return of <code>require('request')</code> so you can use it inside NodeJS without
the IO abstraction.</p>
</div>
</div>
<div id="method_send" class="method item public">
<h3 class="name"><code>send</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>config</code>
</li>
<li class="arg">
<code>id</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag public">public</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l531"><code>io/js/io-base.js:531</code></a>
</p>
</div>
<div class="description">
<p>Requests a transaction. <code>send()</code> is implemented as <code>Y.io()</code>. Each
transaction may include a configuration object. Its properties are:</p>
<dl>
<dt>method</dt>
<dd>HTTP method verb (e.g., GET or POST). If this property is not
not defined, the default value will be GET.</dd>
<dt>data</dt>
<dd>This is the name-value string that will be sent as the
transaction data. If the request is HTTP GET, the data become
part of querystring. If HTTP POST, the data are sent in the
message body.</dd>
<dt>xdr</dt>
<dd>Defines the transport to be used for cross-domain requests.
By setting this property, the transaction will use the specified
transport instead of XMLHttpRequest. The properties of the
transport object are:
<dl>
<dt>use</dt>
<dd>The transport to be used: 'flash' or 'native'</dd>
<dt>dataType</dt>
<dd>Set the value to 'XML' if that is the expected response
content type.</dd>
<dt>credentials</dt>
<dd>Set the value to 'true' to set XHR.withCredentials property to true.</dd>
</dl></dd>
<dt>form</dt>
<dd>Form serialization configuration object. Its properties are:
<dl>
<dt>id</dt>
<dd>Node object or id of HTML form</dd>
<dt>useDisabled</dt>
<dd><code>true</code> to also serialize disabled form field values
(defaults to <code>false</code>)</dd>
</dl></dd>
<dt>on</dt>
<dd>Assigns transaction event subscriptions. Available events are:
<dl>
<dt>start</dt>
<dd>Fires when a request is sent to a resource.</dd>
<dt>complete</dt>
<dd>Fires when the transaction is complete.</dd>
<dt>success</dt>
<dd>Fires when the HTTP response status is within the 2xx
range.</dd>
<dt>failure</dt>
<dd>Fires when the HTTP response status is outside the 2xx
range, if an exception occurs, if the transation is aborted,
or if the transaction exceeds a configured <code>timeout</code>.</dd>
<dt>end</dt>
<dd>Fires at the conclusion of the transaction
lifecycle, after <code>success</code> or <code>failure</code>.</dd>
</dl>
<p>Callback functions for <code>start</code> and <code>end</code> receive the id of the
transaction as a first argument. For <code>complete</code>, <code>success</code>, and
<code>failure</code>, callbacks receive the id and the response object
(usually the XMLHttpRequest instance). If the <code>arguments</code>
property was included in the configuration object passed to
<code>Y.io()</code>, the configured data will be passed to all callbacks as
the last argument.</p>
</dd>
<dt>sync</dt>
<dd>Pass <code>true</code> to make a same-domain transaction synchronous.
<strong>CAVEAT</strong>: This will negatively impact the user
experience. Have a <em>very</em> good reason if you intend to use
this.</dd>
<dt>context</dt>
<dd>The "`this'" object for all configured event handlers. If a
specific context is needed for individual callbacks, bind the
callback to a context using <code>Y.bind()</code>.</dd>
<dt>headers</dt>
<dd>Object map of transaction headers to send to the server. The
object keys are the header names and the values are the header
values.</dd>
<dt>timeout</dt>
<dd>Millisecond threshold for the transaction before being
automatically aborted.</dd>
<dt>arguments</dt>
<dd>User-defined data passed to all registered event handlers.
This value is available as the second argument in the "start" and
"end" event handlers. It is the third argument in the "complete",
"success", and "failure" event handlers. <strong>Be sure to quote
this property name in the transaction configuration as
"arguments" is a reserved word in JavaScript</strong> (e.g.
<code>Y.io({ ..., "arguments": stuff })</code>).</dd>
</dl>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Qualified path to transaction resource.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
<li class="param">
<code class="param-name">id</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<p>Transaction id, if already set.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
</div>
</div>
</div>
<div id="method_setHeader" class="method item">
<h3 class="name"><code>setHeader</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>name</code>
</li>
<li class="arg">
<code>value</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l400"><code>io/js/io-base.js:400</code></a>
</p>
</div>
<div class="description">
<p>Stores default client headers for all transactions. If a label is
passed with no value argument, the header will be deleted.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">name</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>HTTP header</p>
</div>
</li>
<li class="param">
<code class="param-name">value</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>HTTP header value</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_start" class="method item">
<h3 class="name"><code>start</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l232"><code>io/js/io-base.js:232</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:start" and creates, fires a transaction-specific
start event, if <code>config.on.start</code> is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_stringify" class="method item">
<h3 class="name"><code>stringify</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>form</code>
</li>
<li class="arg">
<code class="optional">[options]</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-form.html">io-form</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-form.js.html#l11"><code>io/js/io-form.js:11</code></a>
</p>
</div>
<div class="description">
<p>Enumerate through an HTML form's elements collection
and return a string comprised of key-value pairs.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">form</code>
<span class="type"><a href="../classes/Node.html" class="crosslink">Node</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>YUI form node or HTML form id</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[options]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Configuration options.</p>
</div>
<ul class="params-list">
<li class="param">
<code class="param-name optional">[useDisabled=false]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Boolean" class="crosslink external" target="_blank">Boolean</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Whether to include disabled fields.</p>
</div>
</li>
<li class="param">
<code class="param-name optional">[extra]</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<span class="flag optional" title="This parameter is optional.">optional</span>
<div class="param-description">
<p>Extra values to include. May be a query string or an object with key/value pairs.</p>
</div>
</li>
</ul>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>:
</div>
</div>
</div>
<div id="method_success" class="method item">
<h3 class="name"><code>success</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>transaction</code>
</li>
<li class="arg">
<code>config</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l284"><code>io/js/io-base.js:284</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:success" and creates, fires a transaction-specific
"success" event, if config.on.success is defined.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">transaction</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object.</p>
</div>
</li>
<li class="param">
<code class="param-name">config</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_transport" class="method item">
<h3 class="name"><code>transport</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>o</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l263"><code>io/js/io-xdr.js:263</code></a>
</p>
</div>
<div class="description">
<p>Initializes the desired transport.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>object of transport configurations.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_transports.nodejs" class="method item">
<h3 class="name"><code>transports.nodejs</code></h3>
<span class="paren">()</span>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-nodejs.html">io-nodejs</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-nodejs.js.html#l41"><code>io/js/io-nodejs.js:41</code></a>
</p>
</div>
<div class="description">
<p>NodeJS IO transport, uses the NodeJS <a href="https://github.com/mikeal/request">request</a>
module under the hood to perform all network IO.</p>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
This object contains only a <code>send</code> method that accepts a
<code>transaction object</code>, <code>uri</code> and the <code>config object</code>.
</div>
</div>
<div class="example">
<h4>Example:</h4>
<div class="example-content">
<pre class="code prettyprint"><code>Y.io('https://somedomain.com/url', {
method: 'PUT',
data: '?foo=bar',
//Extra request module config options.
request: {
maxRedirects: 100,
strictSSL: true,
multipart: [
{
'content-type': 'application/json',
body: JSON.stringify({
foo: 'bar',
_attachments: {
'message.txt': {
follows: true,
length: 18,
'content_type': 'text/plain'
}
}
})
},
{
body: 'I am an attachment'
}
]
},
on: {
success: function(id, e) {
Y.log(e.responseText);
}
}
});
</code></pre>
</div>
</div>
</div>
<div id="method_xdr" class="method item">
<h3 class="name"><code>xdr</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>uri</code>
</li>
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l156"><code>io/js/io-xdr.js:156</code></a>
</p>
</div>
<div class="description">
<p>Method for accessing the transport's interface for making a
cross-domain transaction.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">uri</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<ul>
<li>qualified path to transaction resource.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>Transaction object generated by _create() in io-base.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<ul>
<li>configuration object for the transaction.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_xdrReady" class="method item protected">
<h3 class="name"><code>xdrReady</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>yid</code>
</li>
<li class="arg">
<code>uid</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="flag protected">protected</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l277"><code>io/js/io-xdr.js:277</code></a>
</p>
</div>
<div class="description">
<p>Fires event "io:xdrReady"</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">yid</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>YUI sandbox id.</li>
</ul>
</div>
</li>
<li class="param">
<code class="param-name">uid</code>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<div class="param-description">
<ul>
<li>IO instance id.</li>
</ul>
</div>
</li>
</ul>
</div>
</div>
<div id="method_xdrResponse" class="method item">
<h3 class="name"><code>xdrResponse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>e</code>
</li>
<li class="arg">
<code>o</code>
</li>
<li class="arg">
<code>c</code>
</li>
</ul><span class="paren">)</span>
</div>
<span class="returns-inline">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l211"><code>io/js/io-xdr.js:211</code></a>
</p>
</div>
<div class="description">
<p>Response controller for cross-domain requests when using the
Flash transport or IE8's XDomainRequest object.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">e</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>
<div class="param-description">
<p>Event name</p>
</div>
</li>
<li class="param">
<code class="param-name">o</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Transaction object generated by _create() in io-base.</p>
</div>
</li>
<li class="param">
<code class="param-name">c</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<div class="param-description">
<p>Configuration object for the transaction.</p>
</div>
</li>
</ul>
</div>
<div class="returns">
<h4>Returns:</h4>
<div class="returns-description">
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>:
</div>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__cB" class="property item private">
<h3 class="name"><code>_cB</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l19"><code>io/js/io-xdr.js:19</code></a>
</p>
</div>
<div class="description">
<p>Map of stored configuration objects when using
Flash as the transport for cross-domain requests.</p>
</div>
</div>
<div id="property__headers" class="property item private">
<h3 class="name"><code>_headers</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l52"><code>io/js/io-base.js:52</code></a>
</p>
</div>
<div class="description">
<p>Object of IO HTTP headers sent with each transaction.</p>
</div>
</div>
<div id="property__id" class="property item private">
<h3 class="name"><code>_id</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l43"><code>io/js/io-base.js:43</code></a>
</p>
</div>
<div class="description">
<p>A counter that increments for each transaction.</p>
</div>
</div>
<div id="property__q" class="property item private">
<h3 class="name"><code>_q</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l11"><code>io/js/io-queue.js:11</code></a>
</p>
</div>
<div class="description">
<p>Array of transactions queued for processing</p>
</div>
</div>
<div id="property__qState" class="property item private">
<h3 class="name"><code>_qState</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<span class="flag private">private</span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-queue.html">io-queue</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-queue.js.html#l23"><code>io/js/io-queue.js:23</code></a>
</p>
</div>
<div class="description">
<p>Property to determine whether the queue is set to
1 (active) or 0 (inactive). When inactive, transactions
will be stored in the queue until the queue is set to active.</p>
</div>
</div>
<div id="property__rS" class="property item private">
<h3 class="name"><code>_rS</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l29"><code>io/js/io-xdr.js:29</code></a>
</p>
</div>
<div class="description">
<p>Map of transaction simulated readyState values
when XDomainRequest is the transport.</p>
</div>
</div>
<div id="property__timeout" class="property item private">
<h3 class="name"><code>_timeout</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l63"><code>io/js/io-base.js:63</code></a>
</p>
</div>
<div class="description">
<p>Object that stores timeout values for any transaction with a defined
"timeout" configuration property.</p>
</div>
</div>
<div id="property__transport" class="property item private">
<h3 class="name"><code>_transport</code></h3>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external" target="_blank">Object</a></span>
<span class="flag private">private</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l117"><code>io/js/io-xdr.js:117</code></a>
</p>
</div>
<div class="description">
<p>Map of io transports.</p>
</div>
</div>
<div id="property_delay" class="property item">
<h3 class="name"><code>delay</code></h3>
<span class="type"><a href="../classes/Number.html" class="crosslink">Number</a></span>
<span class="flag static">static</span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l303"><code>io/js/io-xdr.js:303</code></a>
</p>
</div>
<div class="description">
<p>Delay value to calling the Flash transport, in the
event io.swf has not finished loading. Once the E<em>XDR</em>READY
event is fired, this value will be set to 0.</p>
</div>
</div>
</div>
<div id="events" class="api-class-tabpanel">
<h2 class="off-left">Events</h2>
<div id="event_io:complete" class="events item">
<h3 class="name"><code>io:complete</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l258"><code>io/js/io-base.js:258</code></a>
</p>
</div>
<div class="description">
<p>Signals the completion of the request-response phase of a
transaction. Response status and data are accessible, if
available, in this event.</p>
</div>
</div>
<div id="event_io:end" class="events item">
<h3 class="name"><code>io:end</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l276"><code>io/js/io-base.js:276</code></a>
</p>
</div>
<div class="description">
<p>Signals the end of the transaction lifecycle.</p>
</div>
</div>
<div id="event_io:failure" class="events item">
<h3 class="name"><code>io:failure</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l311"><code>io/js/io-base.js:311</code></a>
</p>
</div>
<div class="description">
<p>Signals an HTTP response with status outside of the 2xx range.
Fires after io:complete.</p>
</div>
</div>
<div id="event_io:progress" class="events item">
<h3 class="name"><code>io:progress</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l331"><code>io/js/io-base.js:331</code></a>
</p>
</div>
<div class="description">
<p>Signals the interactive state during a file upload transaction.
This event fires after io:start and before io:complete.</p>
</div>
</div>
<div id="event_io:start" class="events item">
<h3 class="name"><code>io:start</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l241"><code>io/js/io-base.js:241</code></a>
</p>
</div>
<div class="description">
<p>Signals the start of an IO request.</p>
</div>
</div>
<div id="event_io:success" class="events item">
<h3 class="name"><code>io:success</code></h3>
<span class="type"></span>
<div class="meta">
<p>
Defined in
<a href="../files/io_js_io-base.js.html#l293"><code>io/js/io-base.js:293</code></a>
</p>
</div>
<div class="description">
<p>Signals an HTTP response with status in the 2xx range.
Fires after io:complete.</p>
</div>
</div>
<div id="event_io:xdrReady" class="events item">
<h3 class="name"><code>io:xdrReady</code></h3>
<span class="type"></span>
<div class="meta">
<p>Provided by the <a href="../modules/io-xdr.html">io-xdr</a> module.</p>
<p>
Defined in
<a href="../files/io_js_io-xdr.js.html#l13"><code>io/js/io-xdr.js:13</code></a>
</p>
</div>
<div class="description">
<p>Fires when the XDR transport is ready for use.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>