Functiondojo._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.

Usage

function (/*dojo.__IoArgs*/ args, /*Function*/ canceller, /*Function*/ okHandler, /*Function*/ errHandler) (view source)
parametertypedescription
argsdojo.__IoArgsThe args object passed into the public io call. Recognized properties on the args object are:
fieldtypedescription
.contentObjectOptional. Contains properties with string values. These properties will be serialized as name1=value2 and passed in the request.
.errorFunctionOptional. function(response, ioArgs){}. response is an Object, ioArgs is of type dojo.__IoCallbackArgs. The error function will be called in an error case.
.formDOMNodeOptional. DOM node for a form. Used to extract the form values and send to the server.
.handleFunctionOptional. 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:
.handleAsStringOptional. Acceptable values depend on the type of IO transport (see specific IO calls for more information).
.loadFunctionOptional. function(response, ioArgs){}. response is an Object, ioArgs is of type dojo.__IoCallbackArgs. The load function will be called on a successful response.
.preventCacheBooleanOptional. 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.
.timeoutIntegerOptional. Milliseconds to wait for the response. If this time passes, the then error callbacks are called.
.urlStringURL to server endpoint.
cancellerFunction 
okHandlerFunctionThe 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.
errHandlerFunctionThe 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.