Page History

...

Table Cell (td)
String

...

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'

Divcache

styleindex	display:none

...

id	description

...

padding	0px
width	80px

...

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Summary

true
refresh	100d
showRefresh	true
id	doc
title	Refresh page
showDate	true
retry	Enable

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryNeeds to be called when not reading content via getResponseBody or getMediaData to be able to reuse the client.Get the charset of the response body

...

Table Cell (td)
byte[]

...

Table Cell (td)
String

...

.

Getter for the exception message.

Get the content of response as binary data.

...

Get the content of the response as String.

...

Table Cell (td)
Object

...

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

...

Table Cell (td)
Object

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

...

Table Cell (td)
Number

...

Table Row (tr)

id	name

Table Cell (td)
getMediaData

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

byte[]

Span

style	font-weight: bold;

getMediaData

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

byte[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var mediaData = response.getMediaData();

...

class	lastDetailRow

...

id	getResponseBody

Table Row (tr)

id	name

Table Cell (td)
getResponseBody

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getResponseBody

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the content of the response as String.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var pageData = response.getResponseBody();

...

class	lastDetailRow

...

id	getResponseHeaders

Table Row (tr)

id	name

Table Cell (td)
getResponseHeaders

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getResponseHeaders

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

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

...

class	lastDetailRow

...

id	getResponseHeaders-String

Table Row (tr)

id	name

Table Cell (td)
getResponseHeaders

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Object

Span

style	font-weight: bold;

getResponseHeaders

Span
(headerName)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} headerName

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Object

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

...

class	lastDetailRow

...

id	getStatusCode

Table Row (tr)

id	name

Table Cell (td)
getStatusCode

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getStatusCode

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Number

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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

...

class	lastDetailRow

...

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

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

id	getCharset

Table Row (tr)

id	name

Table Cell (td)
getCharset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getCharset

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the charset of the response body.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var charset = response.getCharset();

...

class	lastDetailRow

...

id	getMediaData

Gets the status code's reason phrase.

functionservoy sDetail2100%height:30px2Methods Detailsclosename

close()

des

sIndent

Needs to be called when not reading content via getResponseBody or getMediaData
to be able to reuse the client.

ret

Returns

sIndent

true if the entity content is consumed and content stream (if exists) is closed

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getCharset

name

getCharset()

des

sIndent

Get the charset of the response body.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getException

name

getException()

des

sIndent

Getter for the exception message.

ret

Returns

sIndent

the exception message

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getMediaData

name

getMediaData()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getResponseBody

name

getResponseBody()

des

sIndent

Get the content of the response as String.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getResponseHeaders

name

getResponseHeaders()

des

sIndent

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

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getResponseHeaders

name

getResponseHeaders(headerName)

des

sIndent

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

prs

Parameters

sIndent

headerName

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getStatusCode

name

getStatusCode()

des

sIndent

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

In case there was an exception executing the request, please ignore/do not use this value (it will be 0).
You can check that situation using response.getException().

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

getStatusReasonPhrase

name

getStatusReasonPhrase()

des

sIndent

Gets the status code's reason phrase. For example if a response contains status code 403 (Forbidden) it might be useful to know why.

For example a Jenkins API req. could answer with "403 No valid crumb was included in the request" which will let you know
that you simply have to reques a crumb and then put that in the request headers as "Jenkins-Crumb". But you could not know that from 403 status alone...

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 11

New Version Current

Key

getMediaData

getResponseBody

getResponseHeaders

getResponseHeaders

getStatusCode

getCharset

close()

getCharset()

getException()

getMediaData()

getResponseBody()

getResponseHeaders()

getResponseHeaders(headerName)

getStatusCode()

getStatusReasonPhrase()