Class AjaxRequest

Object
   |
   +--Ajax
         |
         +--AjaxRequest

Direct Known Subclasses:

AjaxUpdater, AjaxService

class AjaxRequest

extends Ajax

Defined in ajax.js

Field Detail

async

Boolean async

Whether to use an asynchronous request

body

String body

Request body

contentType

String contentType

Content type. Defaults to 'application/x-www-form-urlencoded'

encoding

String encoding

Character encoding

form

Object form

Associated form

formFields

Array formFields

Associated form fields

formUpload

Boolean formUpload

Indicates if the form associated with the request contains files to be uploaded

formValidate

Boolean formValidate

Indicates if the form associated with the request should be validated

headers

Hash headers

Set of HTTP headers

ifModified

Boolean ifModified

Whether an If-Modified-Since header should be sent

method

String method

Request method (GET or POST)

params

Hash params

Hash of GET/POST parameters

secureUri

String secureUri

Secure URI, when using IFRAME to upload files

throbber

Object throbber

Throbber to be used during the request

uri

String uri

Request URI

AjaxRequest

AjaxRequest(<String> uri, <Object> args)

This class is able to perform HTTP requests using Ajax. It's fully customizable, once you're able to configure HTTP headers, parameters, content type and body. Besides, the class is able to respond to different response types: JSON, XML, Javascript or HTML

Parameters:
uri - Request URI (with or without a query string)
args - Arguments

abort

Boolean abort()

This method can be used to abort a request in progress

addParam

void addParam(<String> param, <Object> val)

Adds a new request parameter

Parameters:
param - Param name
val - Param value

buildQueryString

 <private> String buildQueryString()

Internal method used by AjaxRequest.send() to build the query string included in the HTTP request

createResponse

 <private> AjaxResponse createResponse()

Internal method used by AjaxRequest.onStateChange() to create a new instance of the AjaxResponse class

doFormUpload

 <private> void doFormUpload()

Method called when the form associated with the AJAX request contains one or more files to upload. Performs the request by submitting the form through an IFRAME element

onStateChange

 <private> void onStateChange()

Internal method used to handle ready state changes. When the request state changes to complete, a response object is created and the proper events are fired: onComplete, onJSONResult (if a json object is available), onXMLResult (if responseXML is available), onSuccess (successful HTTP response code) and onFailure (HTTP error)

readArguments

void readArguments(<Object> args)

Parses the arguments provided to the AjaxRequest constructor. Acceptable argument names:
• method
• async
• headers
• contentType
• encoding
• ifModified
• params
• form
• formFields
• formUpload
• formValidate
• body
• throbber
• secureUri
• scope
• onLoading
• onLoaded
• onInteractive
• onComplete
• onSuccess
• onFailure
• onJSONResult
• onXMLResult
• onException

Parameters:
args - Arguments

release

 <private> void release()

Release the connection object

send

void send()

Method that effectively creates and performs the Ajax HTTP request. If the class contains a form that requires validation, its validator will be executed, aborting the request in case of failure. An exception during the send process will raise an onException event