Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Cache
indextrue
refresh100d
showRefreshtrue
iddoc
titleRefresh page
showDatetrue
retryEnable

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.Add a parameter to the post.voidExecute the request method asynchronous using windows authentication.voidExecute the request method asynchronous using windows authentication.voidExecute the request method asynchronous.voidExecutes the request method asynchronous.voidExecute the request method asynchronous.voidExecutes the request method asynchronous.Execute the request method.Execute the request method.Execute a request method using windows authentication.voidSet the body of the request.voidSet the body of the request and content mime type.voidSet the charset used when posting.Set a file to put.Set a file to put.voidWhatever 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 DetailsaddFilename

addFile(parameterName, jsFile)

dessIndent
Add a file to the post.
prs

Parameters

sIndentparameterName ;jsFile ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowaddFilename

addFile(parameterName, fileName, jsFile)

dessIndent
Add a file to the post.
prs

Parameters

sIndentparameterName ;fileName ;jsFile ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
addFilename

addFile(parameterName, fileName, fileLocation)

dessIndent
Add a file to the post.
prs

Parameters

sIndentparameterName ;fileName ;fileLocation ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
addHeadername

addHeader(headerName, value)

dessIndent
Add a header to the request.
prs

Parameters

sIndentheaderName ;value ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
addParametername

addParameter(name, value)

dessIndent
Add a parameter to the post.
prs

Parameters

sIndentname ;value ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

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

dessIndent
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.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordworkstationThe workstation the authentication request is originating from.domainThe domain to authenticate within.successCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

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

dessIndent
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.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordworkstationThe workstation the authentication request is originating from.domainThe domain to authenticate within.successCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors outcallbackExtraArgsextra 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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)

dessIndent
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.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

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

dessIndent
Executes the request method asynchronous.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentusernamethe user namepasswordthe passwordsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors outcallbackExtraArgsextra 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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)

dessIndent
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.
prs

Parameters

sIndentsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors out
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeAsyncRequestname

executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)

dessIndent
Executes the request method asynchronous.
Success callback method will be called when response is received. Response is sent as parameter in callback followed by any 'callbackExtraArgs' that were given.
If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
prs

Parameters

sIndentsuccessCallbackMethodcallbackMethod to be called after response is receivederrorCallbackMethodcallbackMethod to be called if request errors outcallbackExtraArgsextra 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

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest()

dessIndent
Execute the request method.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest(userName, password)

dessIndent
Execute the request method.
prs

Parameters

sIndentuserNamethe user namepasswordthe password
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
executeRequestname

executeRequest(userName, password, workstation, domain)

dessIndent
Execute a request method using windows authentication.
prs

Parameters

sIndentuserNamethe user namepasswordthe passwordworkstationThe workstation the authentication request is originating from.domainThe domain to authenticate within.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setBodyContentname

setBodyContent(content)

dessIndent
Set the body of the request.
prs

Parameters

sIndentcontent ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setBodyContentname

setBodyContent(content, mimeType)

dessIndent
Set the body of the request and content mime type.
prs

Parameters

sIndentcontent ;mimeType ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCharsetname

setCharset(charset)

dessIndent
Set the charset used when posting. If this is null or not called it will use the default charset (UTF-8).
prs

Parameters

sIndentcharset ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setFilename

setFile(file)

dessIndent
Set a file to put.
prs

Parameters

sIndentfile ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setFilename

setFile(filePath)

dessIndent
Set a file to put.
prs

Parameters

sIndentfilePath ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
usePreemptiveAuthenticationname

usePreemptiveAuthentication(b)

dessIndent
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

sIndentb ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow