Page History

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

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)
addHeader(headerName, value) Add a header to the request.

...

Table Cell (td)
void

...

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 SummaryAdd a header to the request.voidExecute the request method asynchronous.voidExecute the request method asynchronous using windows authentication.voidExecute the request method asynchronous.voidExecute the request method asynchronous using windows authentication.

...

void

...

Execute the request method asynchronous.

...

void

...

Execute the request method asynchronous

...

Table Cell (td)
Response

...

using windows authentication.

Execute the request method.

...

Table Cell (td)
Response

...

Execute the request method.

...

Table Cell (td)
Response

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

executeAsyncRequest

...

Execute a request method using windows authentication.

...

id	function
class	servoy sDetail

...

padding	0px
width	100%

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	1

Method Details

...

id	addHeader-String_String

Table Row (tr)

id	name

Table Cell (td)
addHeader

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addHeader

Span
(headerName, value)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Add a header to the request.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} headerName
{String} value

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Boolean

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

method.addHeader('Content-type','text/xml; charset=ISO-8859-1')

...

class	lastDetailRow

...

id	executeAsyncRequest-String_String_String_String_Function_Function

Table Row (tr)

id	name

Table Cell (td)
executeAsyncRequest

void

Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent)

functionservoy sDetail2100%height:30px2Methods DetailsaddHeadername

addHeader(headerName, value)

des

sIndent

Add a header to the request.

prs

Parameters

sIndent

headerName

;

value

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)

des

sIndent

Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

prs

Parameters

sIndent

username

the user name

password

the password

workstation

The workstation the authentication request is originating from.

domain

The domain to authenticate within.

successCallbackMethod

callbackMethod to be called after response is received

errorCallbackMethod

callbackMethod to be called if request errors out

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

...

des

...

sIndent

Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.

...

prs

...

Parameters

...

sIndent

...

username

...

the user name

...

password

...

the password

...

workstation

...

The workstation the authentication request is originating from.

...

domain

...

The domain to authenticate within.

...

successCallbackMethod

...

callbackMethod to be called after response is received

...

errorCallbackMethod

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback)

...

class	lastDetailRow

...

id	executeAsyncRequest-String_String_Function_Function

Table Row (tr)

id	name

Table Cell (td)
executeAsyncRequest

...

id	sig

...

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

executeAsyncRequest

...

callbackMethod to be called if request errors out

...

callbackExtraArgs

extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

des

sIndent

Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

prs

Parameters

sIndent

username

the user name

password

the password

successCallbackMethod

callbackMethod to be called after response is received

errorCallbackMethod

callbackMethod to be called if request errors out

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

...

des

...

sIndent

Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter

...

id	prs

...

class	sIndent

...

 followed by any 'callbackExtraArgs' that were given.

prs

Parameters

sIndent

username

the user name

password

the password

successCallbackMethod

callbackMethod to be called after response is received

...

errorCallbackMethod

...

callbackMethod to be called if request errors out

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)

...

class	lastDetailRow

...

id	executeAsyncRequest-Function_Function

Table Row (tr)

id	name

Table Cell (td)
executeAsyncRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

executeAsyncRequest

Span
(successCallbackMethod, errorCallbackMethod)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

...

id	prs

...

class	sIndent

...

callbackExtraArgs

extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

des

sIndent

Execute the request method asynchronous. Success callback method will be called when response is received.
Response is sent as parameter in callback.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

prs

Parameters

sIndent

successCallbackMethod

callbackMethod to be called after response is received

errorCallbackMethod

callbackMethod to be called if request errors out

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeAsyncRequest

name

executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

des

sIndent

Execute the request method asynchronous using windows authentication.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback.
So you need to test the Reponse.getStatusCode() for that to know if everything did go OK.
If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.

prs

Parameters

sIndent

successCallbackMethod

callbackMethod to be called after response is received

...

errorCallbackMethod

...

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

method.executeAsyncRequest(globals.successCallback,globals.errorCallback)

...

class	lastDetailRow

...

id	executeRequest

Table Row (tr)

id	name

Table Cell (td)
executeRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Response

Span

style	font-weight: bold;

executeRequest

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Execute the request method.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Response

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var response = method.executeRequest()

...

class	lastDetailRow

...

id	executeRequest-String_String

Table Row (tr)

id	name

Table Cell (td)
executeRequest

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Response

Span

style	font-weight: bold;

executeRequest

Span
(userName, password)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Execute the request method.

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} userName - the user name
{String} password - the password

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

Response

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var response = method.executeRequest()

...

class	lastDetailRow

...

id	executeRequest-String_String_String_String

Table Row (tr)

id	name

Table Cell (td)
executeRequest

...

id	sig

...

Span

style	margin-right: 5px;

Response

Span

style	font-weight: bold;

executeRequest

...

callbackMethod to be called if request errors out

...

callbackExtraArgs

extra arguments that will be passed to the callback methods; can be used to identify from which request the response arrived when using the same callback method for multiple requests. Please use only simple JSON arguments (primitive types or array/objects of primitive types)

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeRequest

name

executeRequest()

des

sIndent

Execute the request method.

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeRequest

name

executeRequest(userName, password)

des

sIndent

Execute the request method.

prs

Parameters

sIndent

userName

the user name

password

the password

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

executeRequest

name

executeRequest(userName, password, workstation, domain)

...

des

...

sIndent

Execute a request method using windows authentication.

...

prs

...

Parameters

...

sIndent

...

userName

...

the user name

...

password

...

the password

...

workstation

...

The workstation the authentication request is originating from.

...

domain

...

The domain to authenticate within.

...

ret

...

Returns

...

sIndent

clients

...

Supported Clients

sIndent

...

id	sam

...

class	lastDetailRow

...

SmartClient,WebClient,NGClient

sam

Sample

...

class	sIndent

...

Code Block

language	javascript

var response = method.executeRequest('username','password','mycomputername','domain');

sIdent

javascript

lastDetailRow

usePreemptiveAuthentication

name

usePreemptiveAuthentication(b)

des

sIndent

Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to
the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big,
as the authentication request to the client was not yet sent)

prs

Parameters

sIndent

b

;

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

Child pages

Versions Compared

Old Version 12

New Version Current

Key

addHeader

executeAsyncRequest

addHeader(headerName, value)

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

des

executeAsyncRequest

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

des

executeAsyncRequest

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

executeRequest

executeRequest

executeRequest

executeRequest()

executeRequest(userName, password)

executeRequest(userName, password, workstation, domain)

des

usePreemptiveAuthentication(b)