class dom::HttpReq

sys::Obj
  dom::HttpReq

@Js

Source

HttpReq models the request side of an XMLHttpRequest instance.

See pod doc for details.

async

Bool async := true

Source

If true then perform this request asynchronously. Defaults to true

get

Void get(|HttpRes| c)

Source

Convenience for send("GET", "", c).

headers

Str:Str headers := [Str:Str][:]

Source

The request headers to send.

make

new make(|This|? f := null)

Source

Create a new HttpReq instance.

onProgress

Void onProgress(|Int,Int| f)

Source

Optional callback to track progress of request transfers, where loaded is the number of bytes that have been transferred, and total is the total number of bytes to be transferred.

For GET requests, the progress will track the response being downloaded to the browser. For PUT and POST requests, the progress will track the content being uploaded to the server.

Note this callback is only invoked when lengthComputable is true on the underlying progress events.

post

Void post(Obj content, |HttpRes| c)

Source

Convenience for send("POST", content, c).

postForm

Void postForm(Str:Str form, |HttpRes| c)

Source

Post the form map as a HTML form submission. Formats the map into a valid url-encoded content string, and sets Content-Type header to application/x-www-form-urlencoded.

postFormMultipart

Void postFormMultipart(Str:Obj form, |HttpRes| c)

Source

Post the form as a multipart/form-data submission. Formats map into multipart key value pairs, where DomFile values will be encoded with file contents.

resType

Str resType := ""

Source

The type of data contained in the response. It also lets the author change the response type. If an empty string is set as the value, the default value of "text" is used. Set this field to "arraybuffer" to access response as Buf.

send

Void send(Str method, Obj? content, |HttpRes| c)

Source

Send a request with the given content using the given HTTP method (case does not matter). After receiving the response, call the given closure with the resulting HttpRes object.

uri

Uri uri := `#`

Source

The Uri to send the request.

withCredentials

Bool withCredentials := false

Source

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. The default is false.

Requests from a different domain cannot set cookie values for their own domain unless withCredentials is set to true before making the request. The third-party cookies obtained by setting withCredentials to true will still honor same-origin policy and hence can not be accessed by the requesting script through Doc.cookies or from response headers.