Class Index | File Index

Classes


Class myfaces._impl.xhrCore.engine.BaseRequest


Extends myfaces._impl.core.Object.

Defined in: BaseRequest.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Abstract Base for all classes which simulate the xhr level2 object with a different transport

Every class inheriting the interface must expose following methods and attributes

  • open(method, url, async)
  • send(formData)
  • setRequestHeader(key, value)
  • abort()
  • onloadstart()
  • onprogress()
  • onabort()
  • onerror()
  • onload()
  • ontimeout()
  • onloadend()
  • onreadystatechange()

following attributes are supported

  • async
  • url
  • method
  • timeout
  • response
  • responseText
  • responseXML
  • status
  • statusText
Field Summary
Field Attributes Field Name and Description
 
asynchronous request, if set to true then the request happens asynchronously, if possible.
 
send method, allowed values POST and GET
 
readonly ready stte attribute
 
read only response object, containing the response as json/dom representation
 
read only plain text representation of the response
 
xml dom readonly representation of the response
 
readonly status code of the response
 
readonly status text of the response
 
timeout attribute with a timeout for the request in miliseconds
 
url
the url for the call
Method Summary
Method Attributes Method Name and Description
 
aborts the transmission
 
callback once the transmission has started
 
open(method, url, async)
opens the transport element
 
send(formData)
send method
 
setRequestHeader(key, value)
appends a key value pair to the request header if possible
Class Detail
myfaces._impl.xhrCore.engine.BaseRequest()
Abstract Base for all classes which simulate the xhr level2 object with a different transport

Every class inheriting the interface must expose following methods and attributes

  • open(method, url, async)
  • send(formData)
  • setRequestHeader(key, value)
  • abort()
  • onloadstart()
  • onprogress()
  • onabort()
  • onerror()
  • onload()
  • ontimeout()
  • onloadend()
  • onreadystatechange()

following attributes are supported

  • async
  • url
  • method
  • timeout
  • response
  • responseText
  • responseXML
  • status
  • statusText
Field Detail
async
asynchronous request, if set to true then the request happens asynchronously, if possible.

method
send method, allowed values POST and GET

readyState
readonly ready stte attribute

response
read only response object, containing the response as json/dom representation

responseText
read only plain text representation of the response

responseXML
xml dom readonly representation of the response

status
readonly status code of the response

statusText
readonly status text of the response

timeout
timeout attribute with a timeout for the request in miliseconds

url
the url for the call
Method Detail
abort()
aborts the transmission

onloadstart(evt)
callback once the transmission has started
Parameters:
evt

open(method, url, async)
opens the transport element
Parameters:
{String} method
transport method allowed values POST and GET
{String} url
optional url
{Boolean} async
optional param asynchronous transmission if set to true

send(formData)
send method
Parameters:
{Object} formData
data to be posted within the request

setRequestHeader(key, value)
appends a key value pair to the request header if possible
Parameters:
{String} key
the key of the request header entry
{String} value
the value for the key

Documentation generated by JsDoc Toolkit 2.1.0 on Mon Feb 24 2014 18:10:42 GMT-0500 (COT)