Request

external class Request(options: Request.ConstructorOptions? = definedExternally)(source)

Stores information for making a request. In general this does not need to be constructed directly.

See also

Constructors

Link copied to clipboard
constructor(options: Request.ConstructorOptions? = definedExternally)

Types

Link copied to clipboard

Properties

Link copied to clipboard

The function that is called when the request is cancelled.

Link copied to clipboard

Priority is a unit-less value where lower values represent higher priority. For world-based objects, this is usually the distance from the camera. A request that does not have a priority function defaults to a priority of 0.

Link copied to clipboard

The function that is called to update the request's priority, which occurs once per frame.

Link copied to clipboard

The function that makes the actual data request.

Link copied to clipboard

The current state of the request.

Link copied to clipboard

Whether to throttle and prioritize the request. If false, the request will be sent immediately. If true, the request will be throttled and sent based on priority.

Link copied to clipboard

Whether to throttle the request by server. Browsers typically support about 6-8 parallel connections for HTTP/1 servers, and an unlimited amount of connections for HTTP/2 servers. Setting this value to true is preferable for requests going through HTTP/1 servers.

Link copied to clipboard

Type of request.

Link copied to clipboard
var url: String

The URL to request.

Functions

Link copied to clipboard
fun clone(result: Request? = definedExternally): Request

Duplicates a Request instance.