RequestMode enum

Mode is used to determine if cross-origin requests lead to valid responses, and which properties of the response are readable.

Default mode

Requests can be initiated in a variety of ways, and the mode for a request depends on the particular means by which it was initiated.

For example, when a Request object is created using the Request() constructor, the value of the mode property for that Request is set to cors.

However, for requests created other than by the Request() constructor, noCors is typically used as the mode; for example, for embedded resources where the request is initiated from markup, unless the crossorigin attribute is present, the request is in most cases made using the noCors mode — that is, for the <link> or <script> elements (except when used with modules), or <img>, <audio>, <video>, <object>, <embed>, or <iframe> elements.

Inheritance
Available extensions

Values

sameOrigin → const RequestMode

If a request is made to another origin with this mode set, the result is an error. You could use this to ensure that a request is always being made to your origin.

const RequestMode('same-origin')
noCors → const RequestMode

Prevents the method from being anything other than HEAD, GET or POST, and the headers from being anything other than simple headers. If any ServiceWorkers intercept these requests, they may not add or override any headers except for those that are simple headers. In addition, JavaScript may not access any properties of the resulting Response. This ensures that ServiceWorkers do not affect the semantics of the Web and prevents security and privacy issues arising from leaking data across domains.

const RequestMode('no-cors')
cors → const RequestMode

Allows cross-origin requests, for example to access various APIs offered by 3rd party vendors. These are expected to adhere to the CORS protocol. Only a limited set of headers are exposed in the Response, but the body is readable.

const RequestMode('cors')

A mode for supporting navigation. The navigate value is intended to be used only by HTML navigation. A navigate request is created only while navigating between documents.

const RequestMode('navigate')
webSocket → const RequestMode

A special mode used only when establishing a WebSocket connection.

const RequestMode('websocket')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
mode → String
final
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

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

Constants

values → const List<RequestMode>
A constant List of the values in this enum, in order of their declaration.