XMLHttpRequest

EventTarget → XMLHttpRequestEventTarget → js.html.XMLHttpRequest (extern class)

Use XMLHttpRequest (XHR) objects to interact with servers. You can retrieve data from a URL without having to do a full page refresh. This enables a Web page to update just part of a page without disrupting what the user is doing.

Documentation XMLHttpRequest by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

Static Members

UNSENT: Int
OPENED: Int
HEADERS_RECEIVED: Int
LOADING: Int
DONE: Int

Instance Members

onreadystatechange: haxe.Function

An EventHandler that is called whenever the readyState attribute changes.

readyState: Int

Returns an unsigned short, the state of the request.

timeout: Int

Is an unsigned long representing the number of milliseconds a request can take before automatically being terminated.

withCredentials: Bool

Is a Boolean that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies or authorization headers.

Is an XMLHttpRequestUpload, representing the upload process.

responseURL: String

Returns the serialized URL of the response or the empty string if the URL is null.

status: Int

Returns an unsigned short with the status of the response of the request.

statusText: String

Returns a DOMString containing the response string returned by the HTTP server. Unlike XMLHTTPRequest.status, this includes the entire text of the response message ("200 OK", for example).

Is an enumerated value that defines the response type.

response: Dynamic

Returns an ArrayBuffer, Blob, Document, JavaScript object, or a DOMString, depending on the value of XMLHttpRequest.responseType. that contains the response entity body.

responseText: String

Returns a DOMString that contains the response to the request as text, or null if the request was unsuccessful or has not yet been sent.

responseXML: HTMLDocument

Returns a Document containing the response to the request, or null if the request was unsuccessful, has not yet been sent, or cannot be parsed as XML or HTML.

open(method: String, url: String, async: Bool, ?user: String, ?password: String): Void

Initializes a request. This method is to be used from JavaScript code; to initialize a request from native code, use openRequest() instead.

Name Type Default
method String
url String
async Bool
user String (optional)
password String (optional)
setRequestHeader(header: String, value: String): Void

Sets the value of an HTTP request header. You must call setRequestHeader()after open(), but before send().

Name Type
header String
value String
send(?body: HTMLDocument): Void

Sends the request. If the request is asynchronous (which is the default), this method returns as soon as the request is sent.

Name Type Default
body HTMLDocument (optional)
abort(): Void

Aborts the request if it has already been sent.

getResponseHeader(header: String): String

Returns the string containing the text of the specified header, or null if either the response has not yet been received or the header doesn't exist in the response.

Name Type
header String
Returns
String
getAllResponseHeaders(): String

Returns all the response headers, separated by CRLF, as a string, or null if no response has been received.

Returns
String
overrideMimeType(mime: String): Void

Overrides the MIME type returned by the server.

Name Type
mime String
new(ignored: String): Void
Name Type
ignored String