Response

Unknown macro: {div}

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

getCharset()
Get the charset of the response body.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

byte[]

Unknown macro: {td}

getMediaData()
Get the content of response as binary data.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

String

Unknown macro: {td}

getResponseBody()
Get the content of the response as String.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

getResponseHeaders()
Gets the headers of the response as name/value arrays.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Object

Unknown macro: {td}

getResponseHeaders(headerName)
Gets the headers of the response as name/value arrays.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Number

Unknown macro: {td}

getStatusCode()
Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getCharset

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getCharset

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the charset of the response body.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var charset = response.getCharset();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getMediaData

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

byte[]

Unknown macro: {span}

getMediaData

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the content of response as binary data. It also supports gzip-ed content.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

byte[]

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var mediaData = response.getMediaData();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getResponseBody

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

String

Unknown macro: {span}

getResponseBody

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Get the content of the response as String.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

String

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var pageData = response.getResponseBody();

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getResponseHeaders

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

getResponseHeaders

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Gets the headers of the response as name/value arrays.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var allHeaders = response.getResponseHeaders();
var header;

for (header in allHeaders) application.output(header + ': ' + allHeaders[header]);

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getResponseHeaders

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Object

Unknown macro: {span}

getResponseHeaders

Unknown macro: {span}

(headerName)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Gets the headers of the response as name/value arrays.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} headerName

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Object

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var contentLength = response.getResponseHeaders("Content-Length");

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

getStatusCode

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Number

Unknown macro: {span}

getStatusCode

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Gets the status code of the response, the list of the possible values is in HTTP_STATUS constants.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Number

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var status = response.getStatusCode();// compare with HTTP_STATUS constants

Unknown macro: {tr}

Unknown macro: {td}

Child pages

Response

getCharset

getMediaData

getResponseBody

getResponseHeaders

getResponseHeaders

getStatusCode