Versions Compared

Old Version 1

changes.mady.by.user Malcolm Davenport

Saved on

compared with

New Version Current

changes.mady.by.user Malcolm Davenport

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NetRequest

Makes HTTP and similar requests from JavaScript. This object is similar to the standard browser XMLHttpRequest object.

Class Constructor

new NetRequest()

 

Constructs a new NetRequest Object.

Code Block
languagejs
var request = new NetRequest();

Initialization Parameters

 

None

 

Methods

Name Description 
getResponseHeader

Returns the header field value from the response of which the field name matches header, unless the field name is Set-Cookie or Set-Cookie2. Returns null if either the response has not yet been received or the header doesn't exist in the response. 

open

Sets the request method and request URL. This method differs from the standard XMLHttpRequest's open() method by only accepting two parameters (all requests are asynchronous, and the user/password are entered in the request object's user and password properties.)

send

Initiates the request. The optional argument provides the request entity body. The argument is ignored if request method is GET or HEAD.

setRequestHeader

Appends a header to the list of author request headers, or if header is already in the list of author request headers, combines its value with value.

setTimeout

Sets a timeout, after which the request will be aborted with a 500 status. 

 

Properties

Name Description 
oncomplete

Called at the end of the response. This is redundant to onreadystatechange with readyState=4.

Basic Example:

Code Block
languagejs
request.oncomplete = function() { util.debug('request is done'); } 
onreadystatechange

Event handler for readyState.

Basic Example:

Code Block
languagejs
request.onreadystatechange = function () {
     util.debug(request.readyState);
     util.debug(request.status);
}
password

Password used in the request, or null if there is no password.

Basic Example:

Code Block
languagejs
request.password = 'secret'; 
readyState

Returns the current state.

Basic Example:

Code Block
languagejs
 var currentState = request.readyState; // returns integer such as 200
responseFile

If present, along with responseLoc, the response body is placed in the file rather than in responseText.

Basic Example:

Code Block
languagejs
request.responseFile = "text.txt"; 
responseLoc

If present, along with responseFile, the response body is placed in the file rather than in responseText.

Basic Example:

Code Block
languagejs
request.responseLoc = "tmp";
responseText

Returns the text response entity body.

Basic Example:

Code Block
languagejs
var response = request.responseText; 
status

Returns the HTTP status code; such as 200 (success), 500 (internal server error), 404 (file not found), etc..

Basic Example:

Code Block
languagejs
var statusCode = request.status; 
user

Returns the name of the user in the request, or null if there is no username. Sets the user for the request.

Basic Example:

Code Block
languagejs
request.user = "username"; //set username for request
request.user; //"username"