akasha

Class XMLHttpRequest

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.XMLHttpRequestEventTarget

akasha.XMLHttpRequest

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XMLHttpRequest")
public class XMLHttpRequest
extends XMLHttpRequestEventTarget

XMLHttpRequest (XHR) objects are used 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.

See Also:

XMLHttpRequest - MDN, (XMLHttpRequest) # interface-xmlhttprequest

Field Summary

Fields

Modifier and Type	Field and Description
static int	DONE
static int	HEADERS_RECEIVED
static int	LOADING
@JsNullable EventHandler	onreadystatechange An EventHandler that is called whenever the readyState attribute changes.
static int	OPENED
@JsNonNull java.lang.String	responseType The XMLHttpRequest property responseType is an enumerated string value specifying the type of data contained in the response.
int	timeout The XMLHttpRequest.timeout property is an unsigned long representing the number of milliseconds a request can take before automatically being terminated.
static int	UNSENT
boolean	withCredentials The XMLHttpRequest.withCredentials property is a Boolean that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates.

Fields inherited from class akasha.XMLHttpRequestEventTarget

onabort, onerror, onload, onloadend, onloadstart, onprogress, ontimeout

Constructor Summary

Constructors

Constructor and Description
XMLHttpRequest() The XMLHttpRequest() constructor creates a new XMLHttpRequest.

Method Summary

Modifier and Type	Method and Description
void	abort() The XMLHttpRequest.abort() method aborts the request if it has already been sent.
@JsNonNull java.lang.String	getAllResponseHeaders() The XMLHttpRequest method getAllResponseHeaders() returns all the response headers, separated by CRLF, as a string, or returns null if no response has been received.
@JsNullable java.lang.String	getResponseHeader(java.lang.String name) The XMLHttpRequest method getResponseHeader() returns the string containing the text of a particular header's value.
void	open(java.lang.String method, java.lang.String url) The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.
void	open(java.lang.String method, java.lang.String url, boolean async) The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.
void	open(java.lang.String method, java.lang.String url, boolean async, java.lang.String username) The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.
void	open(java.lang.String method, java.lang.String url, boolean async, java.lang.String username, java.lang.String password) The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.
void	overrideMimeType(java.lang.String mime) The XMLHttpRequest method overrideMimeType() specifies a MIME type other than the one provided by the server to be used instead when interpreting the data being transferred in a request.
int	readyState() The XMLHttpRequest.readyState property returns the state an XMLHttpRequest client is in.
jsinterop.base.Any	response() The XMLHttpRequest response property returns the response's body content as an ArrayBuffer, Blob, Document, JavaScript Object, or DOMString, depending on the value of the request's responseType property.
java.lang.String	responseText() The read-only XMLHttpRequest property responseText returns the text received from a server following a request being sent.
java.lang.String	responseURL() The read-only XMLHttpRequest.responseURL property returns the serialized URL of the response or the empty string if the URL is null.
Document	responseXML() The XMLHttpRequest.responseXML read-only property returns a Document containing the HTML or XML retrieved by the request; or null if the request was unsuccessful, has not yet been sent, or if the data can't be parsed as XML or HTML.
void	send() The XMLHttpRequest method send() sends the request to the server.
void	send(Blob body) The XMLHttpRequest method send() sends the request to the server.
void	send(BufferSource body) The XMLHttpRequest method send() sends the request to the server.
void	send(Document body) The XMLHttpRequest method send() sends the request to the server.
void	send(FormData body) The XMLHttpRequest method send() sends the request to the server.
void	send(java.lang.String body) The XMLHttpRequest method send() sends the request to the server.
void	send(URLSearchParams body) The XMLHttpRequest method send() sends the request to the server.
void	send(XMLHttpRequestBodyInit body) The XMLHttpRequest method send() sends the request to the server.
void	setRequestHeader(java.lang.String name, java.lang.String value) The XMLHttpRequest method setRequestHeader() sets the value of an HTTP request header.
int	status() The read-only XMLHttpRequest.status property returns the numerical HTTP status code of the XMLHttpRequest's response.
java.lang.String	statusText() The read-only XMLHttpRequest.statusText property returns a DOMString containing the response's status message as returned by the HTTP server.
XMLHttpRequestUpload	upload() The XMLHttpRequest upload property returns an XMLHttpRequestUpload object that can be observed to monitor an upload's progress.

Methods inherited from class akasha.XMLHttpRequestEventTarget

addAbortListener, addAbortListener, addAbortListener, addErrorListener, addErrorListener, addErrorListener, addLoadendListener, addLoadendListener, addLoadendListener, addLoadListener, addLoadListener, addLoadListener, addLoadstartListener, addLoadstartListener, addLoadstartListener, addProgressListener, addProgressListener, addProgressListener, addTimeoutListener, addTimeoutListener, addTimeoutListener, removeAbortListener, removeAbortListener, removeAbortListener, removeErrorListener, removeErrorListener, removeErrorListener, removeLoadendListener, removeLoadendListener, removeLoadendListener, removeLoadListener, removeLoadListener, removeLoadListener, removeLoadstartListener, removeLoadstartListener, removeLoadstartListener, removeProgressListener, removeProgressListener, removeProgressListener, removeTimeoutListener, removeTimeoutListener, removeTimeoutListener

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DONE

@JsOverlay
public static final int DONE

See Also:

Constant Field Values

HEADERS_RECEIVED

@JsOverlay
public static final int HEADERS_RECEIVED

See Also:

Constant Field Values

LOADING

@JsOverlay
public static final int LOADING

See Also:

Constant Field Values

OPENED

@JsOverlay
public static final int OPENED

See Also:

Constant Field Values

UNSENT

@JsOverlay
public static final int UNSENT

See Also:

Constant Field Values

onreadystatechange

public @JsNullable EventHandler onreadystatechange

An EventHandler that is called whenever the readyState attribute changes. The callback is called from the user interface thread. The XMLHttpRequest.onreadystatechange property contains the event handler to be called when the readystatechange event is fired, that is every time the readyState property of the XMLHttpRequest changes.

See Also:

XMLHttpRequest.onreadystatechange - MDN, XMLHttpRequest

responseType

@XMLHttpRequestResponseType
public @JsNonNull java.lang.String responseType

The XMLHttpRequest property responseType is an enumerated string value specifying the type of data contained in the response.

See Also:

XMLHttpRequest.responseType - MDN, XMLHttpRequest

timeout

public int timeout

The XMLHttpRequest.timeout property is an unsigned long representing the number of milliseconds a request can take before automatically being terminated. The default value is 0, which means there is no timeout. Timeout shouldn't be used for synchronous XMLHttpRequests requests used in a document environment or it will throw an InvalidAccessError exception. When a timeout happens, a timeout event is fired.

See Also:

XMLHttpRequest.timeout - MDN, XMLHttpRequest

withCredentials

public boolean withCredentials

The XMLHttpRequest.withCredentials property is a Boolean that indicates whether or not cross-site Access-Control requests should be made using credentials such as cookies, authorization headers or TLS client certificates. Setting withCredentials has no effect on same-site requests.

See Also:

XMLHttpRequest.withCredentials - MDN, XMLHttpRequest

Constructor Detail

XMLHttpRequest

public XMLHttpRequest()

The XMLHttpRequest() constructor creates a new XMLHttpRequest.

See Also:

XMLHttpRequest.XMLHttpRequest - MDN

Method Detail

readyState

@JsProperty(name="readyState")
 @XMLHttpRequestReadyState
public int readyState()

The XMLHttpRequest.readyState property returns the state an XMLHttpRequest client is in. An XHR client exists in one of the following states:

See Also:

XMLHttpRequest.readyState - MDN, XMLHttpRequest

response

@JsProperty(name="response")
 @Nullable
public jsinterop.base.Any response()

The XMLHttpRequest response property returns the response's body content as an ArrayBuffer, Blob, Document, JavaScript Object, or DOMString, depending on the value of the request's responseType property.

See Also:

XMLHttpRequest.response - MDN, XMLHttpRequest

responseText

@JsProperty(name="responseText")
 @Nonnull
public java.lang.String responseText()

The read-only XMLHttpRequest property responseText returns the text received from a server following a request being sent.

See Also:

XMLHttpRequest.responseText - MDN, XMLHttpRequest

responseURL

@JsProperty(name="responseURL")
 @Nonnull
public java.lang.String responseURL()

The read-only XMLHttpRequest.responseURL property returns the serialized URL of the response or the empty string if the URL is null. If the URL is returned, any URL fragment present in the URL will be stripped away. The value of responseURL will be the final URL obtained after any redirects.

See Also:

XMLHttpRequest.responseURL - MDN, XMLHttpRequest

responseXML

@JsProperty(name="responseXML")
 @Nullable
public Document responseXML()

The XMLHttpRequest.responseXML read-only property returns a Document containing the HTML or XML retrieved by the request; or null if the request was unsuccessful, has not yet been sent, or if the data can't be parsed as XML or HTML.

See Also:

XMLHttpRequest.responseXML - MDN, responseXML - XMLHttpRequest

status

@JsProperty(name="status")
public int status()

The read-only XMLHttpRequest.status property returns the numerical HTTP status code of the XMLHttpRequest's response.

See Also:

XMLHttpRequest.status - MDN, XMLHttpRequest

statusText

@JsProperty(name="statusText")
 @Nonnull
public java.lang.String statusText()

The read-only XMLHttpRequest.statusText property returns a DOMString containing the response's status message as returned by the HTTP server. Unlike XMLHTTPRequest.status which indicates a numerical status code, this property contains the text of the response status, such as "OK" or "Not Found". If the request's readyState is in UNSENT or OPENED state, the value of statusText will be an empty string.

See Also:

XMLHttpRequest.statusText - MDN, XMLHttpRequest

upload

@JsProperty(name="upload")
 @Nonnull
public XMLHttpRequestUpload upload()

The XMLHttpRequest upload property returns an XMLHttpRequestUpload object that can be observed to monitor an upload's progress.

See Also:

XMLHttpRequest.upload - MDN, XMLHttpRequest

abort

public void abort()

The XMLHttpRequest.abort() method aborts the request if it has already been sent. When a request is aborted, its readyState is changed to XMLHttpRequest.UNSENT (0) and the request's status code is set to 0.

See Also:

XMLHttpRequest.abort - MDN, XMLHttpRequest

getAllResponseHeaders

public @JsNonNull java.lang.String getAllResponseHeaders()

The XMLHttpRequest method getAllResponseHeaders() returns all the response headers, separated by CRLF, as a string, or returns null if no response has been received.

See Also:

XMLHttpRequest.getAllResponseHeaders - MDN, getAllResponseHeaders() - XMLHttpRequest

getResponseHeader

public @JsNullable java.lang.String getResponseHeader(@Nonnull
                                                      java.lang.String name)

The XMLHttpRequest method getResponseHeader() returns the string containing the text of a particular header's value.

See Also:

XMLHttpRequest.getResponseHeader - MDN, getResponseHeader() - XMLHttpRequest

open

public void open(@Nonnull
                 java.lang.String method,
                 @Nonnull
                 java.lang.String url)

The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.

See Also:

XMLHttpRequest.open - MDN, open() - XMLHttpRequest

open

public void open(@Nonnull
                 java.lang.String method,
                 @Nonnull
                 java.lang.String url,
                 boolean async,
                 @Nullable
                 java.lang.String username,
                 @Nullable
                 java.lang.String password)

The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.

See Also:

XMLHttpRequest.open - MDN, open() - XMLHttpRequest

open

public void open(@Nonnull
                 java.lang.String method,
                 @Nonnull
                 java.lang.String url,
                 boolean async,
                 @Nullable
                 java.lang.String username)

The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.

See Also:

XMLHttpRequest.open - MDN, open() - XMLHttpRequest

open

public void open(@Nonnull
                 java.lang.String method,
                 @Nonnull
                 java.lang.String url,
                 boolean async)

The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.

See Also:

XMLHttpRequest.open - MDN, open() - XMLHttpRequest

overrideMimeType

public void overrideMimeType(@Nonnull
                             java.lang.String mime)

The XMLHttpRequest method overrideMimeType() specifies a MIME type other than the one provided by the server to be used instead when interpreting the data being transferred in a request.

See Also:

XMLHttpRequest.overrideMimeType - MDN, overrideMimeType() - XMLHttpRequest

send

public void send(@Nonnull
                 Document body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 XMLHttpRequestBodyInit body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 Blob body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 BufferSource body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 FormData body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 URLSearchParams body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send(@Nonnull
                 java.lang.String body)

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

send

public void send()

The XMLHttpRequest method send() sends the request to the server.

See Also:

XMLHttpRequest.send - MDN, send() - XMLHttpRequest

setRequestHeader

public void setRequestHeader(@Nonnull
                             java.lang.String name,
                             @Nonnull
                             java.lang.String value)

The XMLHttpRequest method setRequestHeader() sets the value of an HTTP request header. When using setRequestHeader(), you must call it after calling open(), but before calling send(). If this method is called several times with the same header, the values are merged into one single request header.

See Also:

XMLHttpRequest.setRequestHeader - MDN, setRequestHeader() - XMLHttpRequest