dojo._ioSetArgs
<script src="../../js/dojo.js"></script>
defined in dojo/_base/xhr.js
sets up the Deferred and ioArgs property on the Deferred so it can be used in an io call.
parameter | type | description |
---|
args | dojo.__IoArgs | The args object passed into the public io call. Recognized properties on the args object are:field | type | description |
---|
.content | Object | Optional. Contains properties with string values. These properties will be serialized as name1=value2 and passed in the request. | .error | Function | Optional. function(response, ioArgs){}. response is an Object, ioArgs is of type dojo.__IoCallbackArgs. The error function will be called in an error case. | .form | DOMNode | Optional. DOM node for a form. Used to extract the form values and send to the server. | .handle | Function | Optional. function(response, ioArgs){}. response is an Object, ioArgs is of type dojo.__IoCallbackArgs. The handle function will be called in either the successful or error case. For the load, error and handle functions, the ioArgs object will contain the following properties: | .handleAs | String | Optional. Acceptable values depend on the type of IO transport (see specific IO calls for more information). | .load | Function | Optional. function(response, ioArgs){}. response is an Object, ioArgs is of type dojo.__IoCallbackArgs. The load function will be called on a successful response. | .preventCache | Boolean | Optional. Default is false. If true, then a "dojo.preventCache" parameter is sent in the request with a value that changes with each request (timestamp). Useful only with GET-type requests. | .timeout | Integer | Optional. Milliseconds to wait for the response. If this time passes, the then error callbacks are called. | .url | String | URL to server endpoint. |
|
canceller | Function | |
okHandler | Function | The first OK callback to be registered with Deferred. It has the opportunity to transform the OK response. It will receive one argument -- the Deferred object returned from this function. |
errHandler | Function | The first error callback to be registered with Deferred. It has the opportunity to do cleanup on an error. It will receive two arguments: error (the Error object) and dfd, the Deferred object returned from this function. |