XMLHttpRequest extension type

@AvailableInWorkers("window_and_worker_except_service")

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.

---

API documentation sourced from MDN Web Docs.

on

• JSObject

Implemented types

• XMLHttpRequestEventTarget
• JSObject

Available extensions

• JSObjectUnsafeUtilExtension
• XHRGetters
• XMLHttpRequestGlue

Constructors

XMLHttpRequest()

factory

Properties

hashCode → int

The hash code for this object.

no setter, inherited

onabort ↔ EventHandler?

getter/setter pair, inherited

onerror ↔ EventHandler?

getter/setter pair, inherited

onload ↔ EventHandler?

getter/setter pair, inherited

onloadend ↔ EventHandler?

getter/setter pair, inherited

onloadstart ↔ EventHandler?

getter/setter pair, inherited

onprogress ↔ EventHandler?

getter/setter pair, inherited

onreadystatechange ↔ EventHandler?

getter/setter pair

ontimeout ↔ EventHandler?

getter/setter pair, inherited

readyState → int

@AvailableInWorkers("window_and_worker_except_service")

no setter

response → JSAny?

@AvailableInWorkers("window_and_worker_except_service")

no setter

responseText → String

@AvailableInWorkers("window_and_worker_except_service")

no setter

responseType ↔ XMLHttpRequestResponseType

@AvailableInWorkers("window_and_worker_except_service")

getter/setter pair

responseURL → String

@AvailableInWorkers("window_and_worker_except_service")

no setter

responseXML → Document?

@AvailableInWorkers("window_and_worker_except_service")

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

status → int

@AvailableInWorkers("window_and_worker_except_service")

no setter

statusText → String

@AvailableInWorkers("window_and_worker_except_service")

no setter

timeout ↔ int

@AvailableInWorkers("window_and_worker_except_service")

getter/setter pair

upload → XMLHttpRequestUpload

@AvailableInWorkers("window_and_worker_except_service")

no setter

withCredentials ↔ bool

@AvailableInWorkers("window_and_worker_except_service")

getter/setter pair

Methods

abort() → void

@AvailableInWorkers("window_and_worker_except_service")

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

@AvailableInWorkers("window_and_worker_except_service")

getResponseHeader(String name) → String?

@AvailableInWorkers("window_and_worker_except_service")

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

@AvailableInWorkers("window_and_worker_except_service")

overrideMimeType(String mime) → void

@AvailableInWorkers("window_and_worker_except_service")

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

@AvailableInWorkers("window_and_worker_except_service")

setRequestHeader(String name, String value) → void

@AvailableInWorkers("window_and_worker_except_service")

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

DONE → const int

HEADERS_RECEIVED → const int

LOADING → const int

OPENED → const int

UNSENT → const int