Apr 28, 2024 21:10 Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Returns Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients Sample Parameters Supported Clients SampleSupported Clients
SmartClient
WebClient
NGClient
Methods Details
addFile(parameterName, jsFile)
Add a file to the post.
String
parameterName
;
Object
jsFile
;
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)
addFile(parameterName, fileName, jsFile)
Add a file to the post.
String
parameterName
;
String
fileName
;
Object
jsFile
;
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)
addFile(parameterName, fileName, fileLocation)
Add a file to the post.
String
parameterName
;
String
fileName
;
String
fileLocation
;
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)
addHeader(headerName, value)
Add a header to the request.
String
headerName
;
String
value
;
method.addHeader('Content-type','text/xml; charset=ISO-8859-1')
addParameter(name, value)
Add a parameter to the post.
String
name
;
String
value
;
poster.addParameter('name','value')
poster.addParameter(null,'value') //sets the content to post
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
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.
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
method.executeAsyncRequest('username','password','mycomputername','domain',globals.successCallback,globals.errorCallback)
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod)
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.
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
method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
executeAsyncRequest(successCallbackMethod, errorCallbackMethod)
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.
Function
successCallbackMethod
callbackMethod to be called after response is received
Function
errorCallbackMethod
callbackMethod to be called if request errors out
method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
executeRequest()
Execute the request method.
var response = method.executeRequest()
To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
or getMediaData:
response.close()
executeRequest(userName, password)
Execute the request method.
String
userName
the user name
String
password
the password
var response = method.executeRequest()
To be able to reuse the client, the response must be
closed if the content is not read via getResponseBody
or getMediaData:
response.close()
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.
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.
var response = method.executeRequest('username','password','mycomputername','domain');
setBodyContent(content)
Set the body of the request.
String
content
;
method.setBodyContent(content)
setBodyContent(content, mimeType)
Set the body of the request and content mime type.
String
content
;
String
mimeType
;
method.setBodyContent(content, 'text/xml')
setCharset(charset)
Set the charset used when posting. If this is null or not called it will use the default charset (UTF-8).
Object
charset
;
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