Network Request

Creating a Network Request Object

var xmlHttp = new XMLHttpRequest();

The XMLHttpRequest object provides full access to HTTP, allowing you to send POST and HEAD requests, as well as standard GET requests. The XMLHttpRequest object can synchronously or asynchronously return a response from the web server in the form of text or a DOM document.

Definition

[h2]XMLHttpRequest.onreadystatechange = callBack

• Description

  Specifies the response processing function.

[h2]XMLHttpRequest.open(method, url, async, username, password)

• Description

  Initializes HTTP request parameters.

• Parameters

  Parameter	Type	Mandatory	Description
  method	string	Yes	HTTP request method.
  url	string	Yes	Request body.
  async	boolean	No	Indicates whether the request should be executed asynchronously. The default value is true.
  username	string	No	User name for accessing the specified URL.
  password	string	No	Password for accessing the specified URL.

• Sample code

  var xhr = new XMLHttpRequest();
  xhr.open('GET', '" + "test.php"+ "', true);

[h2]XMLHttpRequest.setRequestHeader(name, value)

• Description

  Sets the request header.

• Parameters

  Parameter	Type	Mandatory	Description
  name	string	Yes	Name of the header to be set.
  value	string	Yes	Header value.

• Sample code

  var xhr = new XMLHttpRequest();
  xhr.setRequestHeader("Content-Type","application/x-www-form-urlencoded");

[h2]XMLHttpRequest.send(body)

• Description

  Sends an HTTP request using the parameters passed to the open() method and an optional request body passed to the send method.

• Parameters

  Parameter	Type	Mandatory	Description
  body	string/document	No	String or document.

• Sample code

  var xhr = new XMLHttpRequest();
  xhr.open('POST', '" + "test.php"+ "', true);
  xhr.send("foo=bar&lorem=ipsum");

[h2]XMLHttpRequest.getAllResponseHeader()

• Description

  Returns all response headers.

[h2]XMLHttpRequest.getResponseHeader(header)

• Description

  Returns the value of the specified HTTP response header.

• Parameters

  Parameter	Type	Mandatory	Description
  header	string	Yes	Name of the HTTP response header to be returned.

• Sample code

  var client = new XMLHttpRequest();
  client.open("GET", "unicorns-are-teh-awesome.txt", true);
  client.send();
  client.onreadystatechange = function() {
    if(this.readyState == this.HEADERS_RECEIVED) {
      console.log(client.getResponseHeader("Content-Type"));
    }
  }

[h2]XMLHttpRequest.abort()

• Description

  Cancels the current request.

[h2]XMLHttpRequest.responseText

• Description

  Returns the response body (excluding the headers) received by the server so far, or an empty string if no data has been received.

[h2]XMLHttpRequest.responseXML

• Description

  Returns a Document object containing the XML retrieved by the request.

[h2]XMLHttpRequest.status

• Description

  Parses the response into XML and returns the result as a Document object.

[h2]XMLHttpRequest.statusText

• Description

  Returns the HTTP status code of a request.

[h2]XMLHttpRequest.readyState

• Description

  Describes the status of an HTTP request. It starts at 0 when the XMLHttpRequest object is created for the first time and progresses, reaching 4 once the full HTTP response has been received.

[h2]XMLHttpRequest.response

• Description

  Returns an ArrayBuffer, Blob, Document, or DOMString, depending on the value of XMLHttpRequest.responseType. The return value contains the entire response entity body.

[h2]XMLHttpRequest.responseType

• Description

  Defines enumerated values of the response type.

[h2]XMLHttpRequest.responseURL

• Description

  Returns a serialized response URL. If the URL is empty, an empty string is returned.

[h2]XMLHttpRequest.timeout

• Description

  Returns an unsigned long integer representing the maximum time, in milliseconds, that the request is allowed to take. If this time is exceeded, the request is automatically terminated.

[h2]XMLHttpRequest.withCredentials

• Description

  Returns a boolean value, indicating whether the cross-domain Access-Control request should contain authorization information, such as cookies or authorization headers.

[h2]XMLHttpRequest.overrideMimeType

• Description

  Overrides the MIME type returned by the server.