XMLHttpRequest extension type

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.

Despite its name, XMLHttpRequest can be used to retrieve any type of data, not just XML.

If your communication needs to involve receiving event data or message data from a server, consider using server-sent events through the EventSource interface. For full-duplex communication, WebSockets may be a better choice.

@AvailableInWorkers("notservice")

on

JSObject

Implemented types

Constructors

XMLHttpRequest(): factory

Properties

hashCode → int: The hash code for this object.
no setterinherited
onabort ↔ EventHandler?: getter/setter pairinherited
onerror ↔ EventHandler?: getter/setter pairinherited
onload ↔ EventHandler?: getter/setter pairinherited
onloadend ↔ EventHandler?: getter/setter pairinherited
onloadstart ↔ EventHandler?: getter/setter pairinherited
onprogress ↔ EventHandler?: getter/setter pairinherited
onreadystatechange ↔ EventHandler?: getter/setter pair
ontimeout ↔ EventHandler?: getter/setter pairinherited
readyState → int: no setter
response → JSAny?: no setter
responseText → String: no setter
responseType ↔ XMLHttpRequestResponseType: getter/setter pair
responseURL → String: no setter
responseXML → Document?: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
status → int: no setter
statusText → String: no setter
timeout ↔ int: getter/setter pair
upload → XMLHttpRequestUpload: no setter
withCredentials ↔ bool: getter/setter pair

Methods

abort() → void: The XMLHttpRequest.abort() method aborts the request if it has already been sent. When a request is aborted, its XMLHttpRequest.readyState is changed to XMLHttpRequest.UNSENT (0) and the request's XMLHttpRequest.status code is set to 0.
addEventListener(String type, EventListener? callback, [JSAny options]) → void: The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
inherited
dispatchEvent(Event event) → bool: The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
inherited
getAllResponseHeaders() → String: The XMLHttpRequest method getAllResponseHeaders() returns all the response headers, separated by , as a string, or returns null if no response has been received.
getResponseHeader(String name) → String?: The XMLHttpRequest method getResponseHeader() returns the string containing the text of a particular header's value.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
open(String method, String url, [bool async, String? username, String? password]) → void: The XMLHttpRequest method open() initializes a newly-created request, or re-initializes an existing one.
overrideMimeType(String mime) → void: 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.
removeEventListener(String type, EventListener? callback, [JSAny options]) → void: The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
inherited
send([JSAny? body]) → void: The XMLHttpRequest method send() sends the request to the server.
setRequestHeader(String name, String value) → void: The XMLHttpRequest method setRequestHeader() sets the value of an HTTP request header. When using setRequestHeader(), you must call it after calling XMLHttpRequest.open, but before calling XMLHttpRequest.send. If this method is called several times with the same header, the values are merged into one single request header.
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Properties

DONE → int: no setter
HEADERS_RECEIVED → int: no setter
LOADING → int: no setter
OPENED → int: no setter
UNSENT → int: no setter