PutRequest

Unknown macro: {div}

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'

Unknown macro: {div}

Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Summary

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

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

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous using windows authentication.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Response

Unknown macro: {td}

executeRequest()
Execute the request method.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Response

Unknown macro: {td}

executeRequest(userName, password)
Execute the request method.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Response

Unknown macro: {td}

executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setBodyContent(content)
Set the body of the request.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setBodyContent(content, mimeType)
Set the body of the request and content mime type.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

void

Unknown macro: {td}

setCharset(charset)
Set the charset used when posting.

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

Boolean

Unknown macro: {td}

setFile(filePath)
Set a file to put.

Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}

Unknown macro: {th}

Method Details

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

addHeader

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

addHeader

Unknown macro: {span}

(headerName, value)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Add a header to the request.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} headerName
{String} value

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeAsyncRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

executeAsyncRequest

Unknown macro: {span}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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 – callbackMethod to be called if request errors out

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeAsyncRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

executeAsyncRequest

Unknown macro: {span}

(username, password, successCallbackMethod, errorCallbackMethod)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} username – the user name
{String} password – the password
{Function} successCallbackMethod – callbackMethod to be called after response is received
{Function} errorCallbackMethod – callbackMethod to be called if request errors out

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeAsyncRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

executeAsyncRequest

Unknown macro: {span}

(successCallbackMethod, errorCallbackMethod)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{Function} successCallbackMethod – callbackMethod to be called after response is received
{Function} errorCallbackMethod – callbackMethod to be called if request errors out

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Response

Unknown macro: {span}

executeRequest

Unknown macro: {span}

()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Execute the request method.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Response

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var response = method.executeRequest()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Response

Unknown macro: {span}

executeRequest

Unknown macro: {span}

(userName, password)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Execute the request method.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Response

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

var response = method.executeRequest()

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

executeRequest

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Response

Unknown macro: {span}

executeRequest

Unknown macro: {span}

(userName, password, workstation, domain)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Execute a request method using windows authentication.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{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.

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Response

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setBodyContent

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

setBodyContent

Unknown macro: {span}

(content)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set the body of the request.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} content

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

method.setBodyContent(content)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setBodyContent

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

setBodyContent

Unknown macro: {span}

(content, mimeType)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set the body of the request and content mime type.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} content
{String} mimeType

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

method.setBodyContent(content, 'text/xml')

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setCharset

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

void

Unknown macro: {span}

setCharset

Unknown macro: {span}

(charset)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

charset

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

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

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {tbody}

Unknown macro: {tr}

Unknown macro: {td}

setFile

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {span}

Boolean

Unknown macro: {span}

setFile

Unknown macro: {span}

(filePath)

Unknown macro: {tr}

Unknown macro: {td}

Unknown macro: {div}

Set a file to put.

Unknown macro: {tr}

Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} filePath

Unknown macro: {tr}

Unknown macro: {td}

Returns

Unknown macro: {div}

Boolean

Unknown macro: {tr}

Unknown macro: {td}

Sample

Unknown macro: {div}

putRequest.setFile('c:/temp/manual_01a.doc')

Unknown macro: {tr}

Unknown macro: {td}

Child pages

PutRequest

addHeader

executeAsyncRequest

executeAsyncRequest

executeAsyncRequest

executeRequest

executeRequest

executeRequest

setBodyContent

setBodyContent

setCharset

setFile