Page History

Divcache

Div

id	description

HTML Table

id

class

servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

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)

styleindex	display:none

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.

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

id

servoy sReturnTypes2100%height: 30px;2Supported ClientssWordListSmartClientsWordListWebClientsWordListNGClient

servoy sSummary12%30%58%height: 30px;3Methods SummaryAdd a file to the post.Add a file to the post.Add a file to the post.Add a header to the request. Table Row (tr)

Table Cell (td)
void

Table Cell (td)executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Table Row (tr) Table Cell (td)

.

Add a parameter to the post.

void

Execute the request method asynchronous using windows authentication.

void

Table Cell (td)executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

Table Row (tr) Table Cell (td)

Execute the request method asynchronous.

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

void

Table Cell (td)

Execute the request method asynchronous.

Table Row (tr)

Table Cell (td)
Response

Table Cell (td)executeRequest()

Table Cell (td)executeRequest(userName, password)

Execute the request method.

Table Row (tr)

Table Cell (td)
Response

Execute the request method.

Table Row (tr)

Table Cell (td)
Response

Table Cell (td)executeRequest(userName, password, workstation, domain)

Table Row (tr) Table Cell (td)

Execute a request method using windows authentication.

setBodyContent(content)

void

Table Cell (td)

Set the body of the request.

Table Row (tr) Table Cell (td)

void

Table Cell (td)setBodyContent(content, mimeType)
Table Row (tr) Table Cell (td)

Set the body of the request and content mime type.

setCharset(charset)

void

Table Cell (td)

Set the charset used when posting

. Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)setFile(filePath)

.

Set a file to put.

HTML Table

functionclass Colgroup Tag Colcolspanservoy sDetail2width100%

Col

Table Head (thead) Table Row (tr)style

height:30px

;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

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')

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	executeAsyncRequest-String_String_String_String_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

Spanid

2

Methods Details

addFile

name

addFile(parameterName, jsFile)

des

sIndent

Add a file to the post.

prs

Parameters

sIndent

parameterName

;

jsFile

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addFile

name

addFile(parameterName, fileName, jsFile)

des

sIndent

Add a file to the post.

prs

Parameters

sIndent

parameterName

;

fileName

;

jsFile

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addFile

name

addFile(parameterName, fileName, fileLocation)

des

sIndent

Add a file to the post.

prs

Parameters

sIndent

parameterName

;

fileName

;

fileLocation

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addHeader

name

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

addParameter

name

addParameter(name, value)

des

sIndent

Add a parameter to the post.

prs

Parameters

sIndent

name

;

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)

Table Row (tr)class

des

Table Cell (td) Div

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. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.

Table Row (tr)id

prs Table Cell (td)class
Parameters DivsIndent{String} username - the user name
{String} password - the password
{String} workstation - The workstation the authentication request is originating from.
{String} domain - The domain to authenticate within.
{Function} successCallbackMethod - callbackMethod to be called after response is received
{Function} errorCallbackMethod -  Table Body (tbody)id executeAsyncRequest-String_String_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
 SpancallbackMethod to be called if request errors outclients
 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)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
Supported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteAsyncRequestnameexecuteAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)tridclassdes Table Cell (td) DivsIndentExecute 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.tridprs Table Cell (td)
Parameters DivclasssIndent{String} username - the user name
{String} password - the password
{Function} successCallbackMethod - callbackMethod to be called after response is received
{Function} 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)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)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
 SpancallbackMethod to be called if request errors outclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteAsyncRequestnameexecuteAsyncRequest(successCallbackMethod, errorCallbackMethod) Table Row (tr)idclassdes Table Cell (td) DivsIndentExecute 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. Table Row (tr)idprs Table Cell (td)
Parameters DivclasssIndent{Function} successCallbackMethod - callbackMethod to be called after response is received
{Function} 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)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
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()
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
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()
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id executeRequest-String_String_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
 SpancallbackMethod to be called if request errors outclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest()dessIndentExecute the request method.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest(userName, password)dessIndentExecute the request method.prsParameters
sIndentuserNamethe user namepasswordthe passwordretReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest(userName, password, workstation, domain)tridclassdes Table Cell (td) DivsIndentExecute a request method using windows authentication.tridprs Table Cell (td)class
Parameters DivsIndent{String} userName - the user name
{String} password - the password
{String} workstation - The workstation the authentication request is originating from.
{String} domain -  Table Row (tr)idThe domain to authenticate within.ret Table Cell (td)
ReturnsdivsIndentclientsclassid
Supported Clients
sIndentResponse Table Row (tr)SmartClient,WebClient,NGClientsam Table Cell (td)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id setBodyContent-String
 Table Row (tr)
id name
 Table Cell (td)
setBodyContent
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
setBodyContent
 Span
(content)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Set the body of the request.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{String} content
 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.setBodyContent(content)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id setBodyContent-String_String
 Table Row (tr)
id name
 Table Cell (td)
setBodyContent
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
setBodyContent
 Span
(content, mimeType)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Set the body of the request and content mime type.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{String} content
{String} mimeType
 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.setBodyContent(content, 'text/xml')
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)
id setCharset-
 Table Row (tr)
id name
 Table Cell (td)
setCharset
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
void
 Span
style font-weight: bold;
setCharset
 Span
(charset)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Set the charset used when posting. If this is null or not called it will use the default charset (UTF-8).
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
charset
 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
var client = plugins.http.createNewHttpClient();
var poster = client.createPostRequest('https://twitter.com/statuses/update.json');
poster.addParameter('status',scopes.globals.textToPost);
poster.addParameter('source','Test Source');
poster.setCharset('UTF-8');
var httpCode = poster.executeRequest(scopes.globals.twitterUserName, scopes.globals.twitterPassword).getStatusCode() // httpCode 200 is ok
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id setFile-String
 Table Row (tr)
id name
 Table Cell (td)
setFile
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
Boolean
 Span
style font-weight: bold;
setFile
 Span
(filePath)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Set a file to put.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{String} filePath
 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
putRequest.setFile('c:/temp/manual_01a.doc')
 Table Row (tr)class lastDetailRow
 Table Cell (td) Sample Div
class sIndent
 Code Block
language javascript
var response = method.executeRequest('username','password','mycomputername','domain');
sIdentjavascriptlastDetailRowsetBodyContentnamesetBodyContent(content)dessIndentSet the body of the request.prsParameters
sIndentcontent ;clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetBodyContentnamesetBodyContent(content, mimeType)dessIndentSet the body of the request and content mime type.prsParameters
sIndentcontent ;mimeType ;clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetCharsetnamesetCharset(charset)dessIndentSet the charset used when posting. If this is null or not called it will use the default charset (UTF-8).prsParameters
sIndentcharset ;clientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetFilenamesetFile(file)dessIndentSet a file to put.prsParameters
sIndentfile ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowsetFilenamesetFile(filePath)dessIndentSet a file to put.prsParameters
sIndentfilePath ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 15

New Version 16

Key

addHeader

executeAsyncRequest

addFile(parameterName, jsFile)

addFile(parameterName, fileName, jsFile)

addFile(parameterName, fileName, fileLocation)

addHeader(headerName, value)

addParameter(name, value)

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

executeAsyncRequest

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

executeAsyncRequest

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

executeRequest

executeRequest

executeRequest

executeRequest()

executeRequest(userName, password)

executeRequest(userName, password, workstation, domain)

setBodyContent

setBodyContent

setCharset

setFile

setBodyContent(content)

setBodyContent(content, mimeType)

setCharset(charset)

setFile(file)

setFile(filePath)