Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Unknown macro: {table} Unknown macro: {tr} Unknown macro: {th} Return Types
Unknown macro: {table}
{column:padding=0px|width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summery
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createHttpClient(http_clientname)
Create a named http client (like a web browser with session binding) usable todo multiple request/posts in same server session.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} deleteHttpClient(http_clientname)
Delete a named http client.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHttpClientCookie(clientName, cookieName)
Get cookie object from the specified client.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHttpClientCookies(clientName)
Returns a Cookie array with all the cookies set on the specified client.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLastPageCharset()
Get the charset of the last page received with getPageData(.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} byte[]
Unknown macro: {td} getMediaData(url, [http_clientname])
Get media (binary data) such as images in a variable.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPageData(url, [http_clientname], [username], [password])
Get all page html in a variable (authentication only works with http client usage).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPoster(url, [http_clientname])
Get poster object to do http (file) posts.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} put(clientName, url, fileName, filePath, [username], [password])
Put a file at the specified URL.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setHttpClientCookie(clientName, cookieName, cookieValue, [domain], [path], [maxAge], [secure])
Add cookie to the specified client.
Unknown macro: {table}
{column:padding=0px|width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} createHttpClient
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} createHttpClient
Unknown macro: {span} (http_clientname)
Unknown macro: {tr} Unknown macro: {td} Create a named http client (like a web browser with session binding) usable todo multiple request/posts in same server session.
Unknown macro: {tr} Unknown macro: {td} Parameters
http_clientname
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
plugins.http.createHttpClient('mybrowser');
var pageData = plugins.http.getPageData('http://www.cnn.com','mybrowser','username','mypassword');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} deleteHttpClient
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} deleteHttpClient
Unknown macro: {span} (http_clientname)
Unknown macro: {tr} Unknown macro: {td} Delete a named http client.
Unknown macro: {tr} Unknown macro: {td} Parameters
http_clientname
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
plugins.http.deleteHttpClient('mybrowser');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHttpClientCookie
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getHttpClientCookie
Unknown macro: {span} (clientName, cookieName)
Unknown macro: {tr} Unknown macro: {td} Get cookie object from the specified client.
Unknown macro: {tr} Unknown macro: {td} Parameters
clientName
cookieName
Unknown macro: {tr} Unknown macro: {td} Returns
Cookie
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var cookie = plugins.http.getHttpClientCookie('clientName', 'JSESSIONID');
if (cookie != null)
{
// do something
}
else
plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getHttpClientCookies
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} Cookie[]
Unknown macro: {span} getHttpClientCookies
Unknown macro: {span} (clientName)
Unknown macro: {tr} Unknown macro: {td} Returns a Cookie array with all the cookies set on the specified client.
Unknown macro: {tr} Unknown macro: {td} Parameters
clientName
Unknown macro: {tr} Unknown macro: {td} Returns
Cookie[]
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var cookies = plugins.http.getHttpClientCookies('clientName')
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getLastPageCharset
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getLastPageCharset
Unknown macro: {tr} Unknown macro: {td} Get the charset of the last page received with getPageData(...)
Unknown macro: {tr} Unknown macro: {td} Returns
String
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var a = plugins.http.getPageData('http://www.google.com.hk');
var charset = plugins.http.getLastPageCharset();
var success = plugins.file.writeTXTFile('someFilePath', a, charset);
if (!success) plugins.dialogs.showWarningDialog('Warning', 'Could not write file', 'OK');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getMediaData
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} byte[]
Unknown macro: {span} getMediaData
Unknown macro: {span} (url, [http_clientname])
Unknown macro: {tr} Unknown macro: {td} Get media (binary data) such as images in a variable. It also supports gzip-ed content.
Unknown macro: {tr} Unknown macro: {td} Parameters
url
[http_clientname]
Unknown macro: {tr} Unknown macro: {td} Returns
byte[]
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var image_byte_array = plugins.http.getMediaData('http://www.cnn.com/cnn.gif');
var image_byte_array2 = plugins.http.getMediaData('http://www.cnn.com/cnn.gif', 'clientName');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPageData
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getPageData
Unknown macro: {span} (url, [http_clientname], [username], [password])
Unknown macro: {tr} Unknown macro: {td} Get all page html in a variable (authentication only works with http client usage). If name is provided a http client will be created/used.
Unknown macro: {tr} Unknown macro: {td} Parameters
url
[http_clientname]
[username]
[password]
Unknown macro: {tr} Unknown macro: {td} Returns
String
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
// get data using a default connection
var pageData = plugins.http.getPageData('http://www.cnn.com');
// create an http client and use it to get the data
var pageData = plugins.http.getPageData('http://www.cnn.com','myclient');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getPoster
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getPoster
Unknown macro: {span} (url, [http_clientname])
Unknown macro: {tr} Unknown macro: {td} Get poster object to do http (file) posts. If posting files, it will post multipart!
Unknown macro: {tr} Unknown macro: {td} Parameters
url
[http_clientname]
Unknown macro: {tr} Unknown macro: {td} Returns
Poster
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var poster = plugins.http.getPoster('http://www.abc.com/apply_form.jsp');
var didAddParam = poster.addParameter('myParamName','myValue');
var didAddFile = poster.addFile('myFileParamName','manual.doc','c:/temp/manual_01a.doc');
var httpCode = poster.doPost('username','mypassword'); //httpCode 200 is ok
//var httpCode = poster.doPost('username','mypassword'); //use if authentication is needed
var pageData = poster.getPageData()
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} put
Unknown macro: {span} (clientName, url, fileName, filePath, [username], [password])
Unknown macro: {tr} Unknown macro: {td} Put a file at the specified URL.
Unknown macro: {tr} Unknown macro: {td} Parameters
clientName
url
fileName
filePath
[username]
[password]
Unknown macro: {tr} Unknown macro: {td} Returns
Boolean
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var fileAdded = plugins.http.put('clientName', 'http://www.abc.com/put_stuff.jsp', 'manual.doc', 'c:/temp/manual_01a.doc', 'user', 'password')
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setClientProxyUserNamePassword
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setClientProxyUserNamePassword
Unknown macro: {span} (username, password)
Unknown macro: {tr} Unknown macro: {td} Set the proxy username and password. Used for named http clients ( else use implicit java data).
Unknown macro: {tr} Unknown macro: {td} Parameters
username
password
Unknown macro: {tr} Unknown macro: {td} Returns
void
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
plugins.http.setClientProxyUserNamePassword('my_proxy_username','my_proxy_password');
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setHttpClientCookie
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} setHttpClientCookie
Unknown macro: {span} (clientName, cookieName, cookieValue, [domain], [path], [maxAge], [secure])
Unknown macro: {tr} Unknown macro: {td} Add cookie to the specified client.
Unknown macro: {tr} Unknown macro: {td} Parameters
clientName
cookieName
cookieValue
[domain]
[path]
[maxAge]
[secure]
Unknown macro: {tr} Unknown macro: {td} Returns
Boolean
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {div}
var cookieSet = plugins.http.setHttpClientCookie('clientName', 'JSESSIONID', 'abc', 'localhost', '/', -1, false)
if (cookieSet)
{
//do something
}
Unknown macro: {tr} Unknown macro: {td}