Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
{div:style=}
Wiki Markup
Div
styledisplay: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.

\\ \\ Enter additional information related to this



Enter additional information related to this 'class'

inside

the

\

{div}

macro

with

'id=description'

{div} {div:id=description}{div}\\ {table:id=|class=servoy sReturnTypes}{tr:style=height: 30px;}{th}Return Types{th}{tr}{tr}{td}{span:class=sWordList}[Cookie]{span}{span:class=sWordList}[DeleteRequest]{span}{span:class=sWordList}[GetRequest]{span}{span:class=sWordList}[HTTP_STATUS]{span}{span:class=sWordList}[HeadRequest]{span}{span:class=sWordList}[HttpClient]{span}{span:class=sWordList}[OptionsRequest]{span}{span:class=sWordList}[PostRequest]{span}{span:class=sWordList}[PutRequest]{span}{span:class=sWordList}[Response]{span}{span:class=sWordList}[TraceRequest]{span}{td}{tr}{table}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[HttpClient]{td}{td}[#createNewHttpClient]\() Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.{td}{tr}{tbody}{tbody}{tr}{td}byte[]{td}{td}[#getMediaData]\(url) Get media (binary data) such as images in a variable.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getPageData]\(url) Get all page html in a variable, if this url is an https url that uses certificates unknown to Java then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client){td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=createNewHttpClient}{tr:id=name}{td}h6.createNewHttpClient{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[HttpClient]{span}{span:style=font-weight: bold;}createNewHttpClient{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[HttpClient]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Div
iddescription


HTML Table
id
classservoy sReturnTypes
Table Row (tr)
styleheight: 30px;
Table Head (th)
Return Types
Table Row (tr)
Table Cell (td)
Span
classsWordList
Cookie
Span
classsWordList
DeleteRequest
Span
classsWordList
GetRequest
Span
classsWordList
HTTP_STATUS
Span
classsWordList
HeadRequest
Span
classsWordList
HttpClient
Span
classsWordList
OptionsRequest
Span
classsWordList
PostRequest
Span
classsWordList
PutRequest
Span
classsWordList
Response
Span
classsWordList
TraceRequest

HTML Table
id
classservoy sSummary
Colgroup Tag
Column
padding0px
width80px

Column

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Body (tbody)
Table Row (tr)
Table Cell (td)
HttpClient
Table Cell (td)
#createNewHttpClient()
Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
byte[]
Table Cell (td)
#getMediaData(url)
Get media (binary data) such as images in a variable.
Table Body (tbody)
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
#getPageData(url)
Get all page html in a variable, if this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)

HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Column
padding0px
width100%

Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan1
Method Details
Table Body (tbody)
idcreateNewHttpClient
Table Row (tr)
idname
Table Cell (td)
createNewHttpClient
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
HttpClient
Span
stylefont-weight: bold;
createNewHttpClient
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Create an http client (like a web browser with session binding) usable todo multiple request/posts in same server session.
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
HttpClient
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var client = plugins.http.createNewHttpClient();
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getMediaData-String}{tr:id=name}{td}h6.getMediaData{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}byte[]{span}{span:style=font-weight: bold;}getMediaData{span}{span}\(url){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get media (binary data) such as images in a variable. It also supports gzip\-ed content. If this url is an https url that uses certificates unknown to Java then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}byte[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetMediaData-String
Table Row (tr)
idname
Table Cell (td)
getMediaData
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
byte[]
Span
stylefont-weight: bold;
getMediaData
Span
(url)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get media (binary data) such as images in a variable. It also supports gzip-ed content.
If this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} url
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
byte[]
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

var image_byte_array = plugins.http.getMediaData('http://www.cnn.com/cnn.gif');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getPageData-String}{tr:id=name}{td}h6.getPageData{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getPageData{span}{span}\(url){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get all page html in a variable, if this url is an https url that uses certificates unknown to Java then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} url {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}
Table Row (tr)
classlastDetailRow
Table Cell (td)

Table Body (tbody)
idgetPageData-String
Table Row (tr)
idname
Table Cell (td)
getPageData
Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getPageData
Span
(url)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get all page html in a variable, if this url is an https url that uses certificates unknown to Java
then you have to use the HttpClient so that smart client users will get the unknown certificate dialog that they then can accept
or you must make sure that those server certificates are stored in the cacerts of the java vm that is used (this is required for a web or headless client)
Table Row (tr)
idprs
Table Cell (td)
Parameters
Div
classsIndent
{String} url
Table Row (tr)
idret
Table Cell (td)
Returns
Div
classsIndent
String
Table Row (tr)
idsam
Table Cell (td)
Sample
Div
classsIndent
Code Block
languagejavascript

// get data using a default connection
var pageData = plugins.http.getPageData('http://www.cnn.com');
{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}
Table Row (tr)
classlastDetailRow
Table Cell (td)