Class Ext.Ajax

• scope : Object

  The scope in which to execute the handler function. The handler function's "this" context.

• delay : Number

  The number of milliseconds to delay the invocation of the handler after the event fires.

• single : Boolean

  True to add a handler to handle just the next firing of the event, and then remove itself.

• buffer : Number

  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

Combining Options
Using the options argument, it is possible to combine different types of listeners:

A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)

el.on('click', this.onClick, this, {
    single: true,
    delay: 100,
    forumId: 4
});

Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers.

foo.on({
    'click' : {
        fn: this.onClick,
        scope: this,
        delay: 100
    },
    'mouseover' : {
        fn: this.onMouseOver,
        scope: this
    },
    'mouseout' : {
        fn: this.onMouseOut,
        scope: this
    }
});

Or a shorthand syntax:

foo.on({
    'click' : this.onClick,
    'mouseover' : this.onMouseOver,
    'mouseout' : this.onMouseOut,
     scope: this
});

• url : String/Function (Optional)
  The URL to which to send the request, or a function to call which returns a URL string. The scope of the function is specified by the scope option. Defaults to configured URL.
• params : Object/String/Function (Optional)
  An object containing properties which are used as parameters to the request, a url encoded string or a function to call to get either. The scope of the function is specified by the scope option.
• method : String (Optional)
  The HTTP method to use for the request. Defaults to the configured method, or if no method was configured, "GET" if no parameters are being sent, and "POST" if parameters are being sent. Note that the method name is case-sensitive and should be all caps.
• callback : Function (Optional)
  The function to be called upon receipt of the HTTP response. The callback is called regardless of success or failure and is passed the following parameters:

  • options : Object
    The parameter to the request call.
  • success : Boolean
    True if the request succeeded.
  • response : Object
    The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response.
• success : Function (Optional)
  The function to be called upon success of the request. The callback is passed the following parameters:

  • response : Object
    The XMLHttpRequest object containing the response data.
  • options : Object
    The parameter to the request call.
• failure : Function (Optional)
  The function to be called upon failure of the request. The callback is passed the following parameters:

  • response : Object
    The XMLHttpRequest object containing the response data.
  • options : Object
    The parameter to the request call.
• scope : Object (Optional)
  The scope in which to execute the callbacks: The "this" object for the callback function. If the url, or params options were specified as functions from which to draw values, then this also serves as the scope for those function calls. Defaults to the browser window.
• form : Element/HTMLElement/String (Optional)
  The <form> Element or the id of the <form> to pull parameters from.
• isUpload : Boolean (Optional)
  Only meaningful when used with the form option.

  True if the form object is a file upload (will be set automatically if the form was configured with enctype "multipart/form-data").

  File uploads are not performed using normal "Ajax" techniques, that is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the DOM <form> element temporarily modified to have its target set to refer to a dynamically generated, hidden <iframe> which is inserted into the document but removed after the return data has been gathered.

  The server response is parsed by the browser to create the document for the IFRAME. If the server is using JSON to send the return object, then the Content-Type header must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.

  The response text is retrieved from the document, and a fake XMLHttpRequest object is created containing a responseText property in order to conform to the requirements of event handlers and callbacks.

  Be aware that file upload packets are sent with the content type multipart/form and some server technologies (notably JEE) may require some custom processing in order to retrieve parameter names and parameter values from the packet content.

• headers : Object (Optional)
  Request headers to set for the request.
• xmlData : Object (Optional)
  XML document to use for the post. Note: This will be used instead of params for the post data. Any params will be appended to the URL.
• jsonData : Object/String (Optional)
  JSON data to use as the post. Note: This will be used instead of params for the post data. Any params will be appended to the URL.
• disableCaching : Boolean (Optional)
  True to add a unique cache-buster param to GET requests.

The options object may also contain any other property which might be needed to perform postprocessing in a callback because it is passed to callback functions.