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)addFile(parameterName, jsFile)

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

Table Cell (td)
Boolean

Table Cell (td)addFile(parameterName, fileName, jsFile)

servoy sSummary

12%

30%

58%

height: 30px;

3

Methods Summary

Add a file to the post.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)addFile(parameterName, fileName, fileLocation)

Add a file to the post.

Table Row (tr)

Add a file to the post.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)addHeader(headerName, value)

addParameter(name, value)

Add a header to the request.

Table Row (tr)

Table Cell (td)
Boolean

Table Cell (td)

Add a parameter to the post.

Table Row (tr) Table Cell (td)

void

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

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

Table Cell (td)executeRequest(userName, password)

Execute the request method.

Table Row (tr)

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.

Table Cell (td)setBodyContent(content)

void

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.

Table Cell (td)setCharset(charset)

void

Set the charset used when posting.

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	addFile-String_Object

Table Row (tr)

id	name

Table Cell (td)
addFile

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addFile

Span

2

Methods Details

addFile

name

addFile(parameterName, jsFile)

tr

id

des

Table Cell (td) Divclassid

sIndent

Add a file to the post.

Table Row (tr)td

prs

class

Parameters

Div Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Boolean

Span

style	font-weight: bold;

addFile

Span

sIndent

{String} parameterName
{Object} jsFile

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

poster.addFile('myFileParamName','manual.doc','c:/temp/manual_01a.doc')
poster.addFile(null,'postXml.xml','c:/temp/postXml.xml') // sets the xml to post

var f = plugins.file.convertToJSFile('./somefile02.txt')
if (f && f.exists()) poster.addFile('myTxtFileParamName','somefile.txt', f)

f = plugins.file.convertToJSFile('./anotherfile_v2b.txt')
if (f && f.exists()) poster.addFile('myOtherTxtFileParamName', f)

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	addFile-String_String_Object

Table Row (tr)

id	name

Table Cell (td)
addFile

parameterName

;

jsFile

;

ret

Returns

sIndent

clients

Supported Clients

sIndent

SmartClient,WebClient,NGClient

sam

Sample

sIdent

javascript

lastDetailRow

addFile

name

addFile(parameterName, fileName, jsFile)

tr

id Divclass

des

Table Cell (td)

sIndent

Add a file to the post.

Table Row (tr)idtd

prsParameters Divclass Table Row (tr)id ret
tdsIndent{String} parameterName
{String} fileName
{Object} jsFileparameterName ;fileName ;jsFile ;ret
ReturnsdivsIndentclientsclasstd
Supported Clients
sIndentBoolean Table Row (tr)id sam
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 Table Body (tbody)id addFile-String_String_String
 Table Row (tr)
id name
 Table Cell (td)
addFile
 Table Row (tr)id sig
 Table Cell (td) Span
style margin-right: 5px;
Boolean
 Span
style font-weight: bold;
addFile
 SpanSmartClient,WebClient,NGClientsamSample Div
class sIndent
 Code Block
language javascript
poster.addFile('myFileParamName','manual.doc','c:/temp/manual_01a.doc')
poster.addFile(null,'postXml.xml','c:/temp/postXml.xml') // sets the xml to post

var f = plugins.file.convertToJSFile('./somefile02.txt')
if (f && f.exists()) poster.addFile('myTxtFileParamName','somefile.txt', f)

f = plugins.file.convertToJSFile('./anotherfile_v2b.txt')
if (f && f.exists()) poster.addFile('myOtherTxtFileParamName', f)
idsIdentjavascriptlastDetailRowaddFilenameaddFile(parameterName, fileName, fileLocation) Table Row (tr)classdes Table Cell (td) DivsIndentAdd a file to the post. Table Row (tr)idtdprsclassParameters Div Table Row (tr)id ret
tdsIndent{String} parameterName
{String} fileName
{String} fileLocationparameterName ;fileName ;fileLocation ;retReturnsdivsIndentclientsclasstd
Supported Clients
sIndentBoolean Table Row (tr)id sam
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
 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
 SpanSmartClient,WebClient,NGClientsamSample Div
class sIndent
 Code Block
language javascript
poster.addFile('myFileParamName','manual.doc','c:/temp/manual_01a.doc')
poster.addFile(null,'postXml.xml','c:/temp/postXml.xml') // sets the xml to post

var f = plugins.file.convertToJSFile('./somefile02.txt')
if (f && f.exists()) poster.addFile('myTxtFileParamName','somefile.txt', f)

f = plugins.file.convertToJSFile('./anotherfile_v2b.txt')
if (f && f.exists()) poster.addFile('myOtherTxtFileParamName', f)
sIdentjavascriptlastDetailRowaddHeadernameaddHeader(headerName, value)tridclassdes Table Cell (td) DivsIndentAdd a header to the request.tridprs Table Cell (td)class
Parameters DivsIndent{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 addParameter-String_String
 Table Row (tr)
id name
 Table Cell (td)
addParameter
 Table Row (tr)
id sig
 Table Cell (td)
 Span
style margin-right: 5px;
Boolean
 Span
style font-weight: bold;
addParameter
 Span
(name, value)
 Table Row (tr)
id des
 Table Cell (td)
 Div
class sIndent
Add a parameter to the post.
 Table Row (tr)
id prs
 Table Cell (td)
Parameters
 Div
class sIndent
{String} name
{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
poster.addParameter('name','value')
poster.addParameter(null,'value') //sets the content to post
 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
 SpanidheaderName ;value ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowaddParameternameaddParameter(name, value)dessIndentAdd a parameter to the post.prsParameters
sIndentname ;value ;retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteAsyncRequestnameexecuteAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod) Table Row (tr)classdes Table Cell (td) DivsIndentExecute 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)idprs Table Cell (td)
ParametersdivclasssIndent{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 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)
 
 Table Body (tbody)id executeAsyncRequest-String_String_Function_Function
 Table Row (tr)
id name
 Table Cell (td)
executeAsyncRequest
Supported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteAsyncRequestnameexecuteAsyncRequest(username, password, 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)idtdprsParameters DivclasssIndent{String} username - the user name
{String} password - the password
{Function} successCallbackMethod - callbackMethod to be called after response is received
{Function} errorCallbackMethod -  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 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(globals.successCallback,globals.errorCallback)
 Table Row (tr)
class lastDetailRow
 Table Cell (td)
 
idSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteAsyncRequestnameexecuteAsyncRequest(successCallbackMethod, errorCallbackMethod) Table Row (tr)classdes Table Cell (td) DividsIndentExecute 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)tdprsclassParameters DivsIndent{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
 SpancallbackMethod to be called if request errors outidclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest()dessIndentExecute the request method.retReturns
sIndentclientsSupported Clients
sIndentSmartClient,WebClient,NGClientsamSample
sIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest(userName, password) Table Row (tr)classdes Table Cell (td) DivsIndentExecute the request method.tridprs Table Cell (td)
ParametersdivclasssIndent{String} userName - the user name
{String} password -  Table Row (tr)idthe passwordtdret
ReturnsdivsIndentclientsclasstd
Supported Clients
sIndentResponse Table Row (tr)id sam
 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
 SpanSmartClient,WebClient,NGClientsamSample Div
class sIndent
 Code Block
language javascript
var response = method.executeRequest()
idsIdentjavascriptlastDetailRowexecuteRequestnameexecuteRequest(userName, password, workstation, domain) Table Row (tr)classdes Table Cell (td) DivsIndentExecute a request method using windows authentication. Table Row (tr)idtdprsParametersdivclasssIndent{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) 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
sIdentjavascriptlastDetailRow

Child pages

Versions Compared

Old Version 15

New Version 16

Key

addFile

addFile(parameterName, jsFile)

addFile

addFile(parameterName, fileName, jsFile)

addFile

addFile(parameterName, fileName, fileLocation)

addHeader

addHeader(headerName, value)

addParameter

executeAsyncRequest

addParameter(name, value)

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

executeAsyncRequest

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

executeAsyncRequest

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

executeRequest

executeRequest

executeRequest()

executeRequest(userName, password)

executeRequest

executeRequest(userName, password, workstation, domain)

setBodyContent

setBodyContent

setCharset

setBodyContent(content)

setBodyContent(content, mimeType)

setCharset(charset)