Child pages
  • HttpClient

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 SummaryCreates a new delete request (a request to delete a resource on server).Creates a new get request (retrieves whatever information is stored on specified url).Creates a new head request (similar to get request, must not contain body content).Creates a new options request (a request for information about communication options).Creates a new patch request (used for granular updates).Create a new post request ( Origin server should accept/process the submitted data.Creates a new put request (similar to post request, contains information to be submitted).Creates a new trace request (debug request, server will just echo back).Get a cookie by name.Get all cookies from this client.voidSet proxy credentials.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.Add cookie to the this client.voidSets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).

functionservoy sDetail2100%height:30px2Methods DetailscreateDeleteRequestname

createDeleteRequest(url)

dessIndent
Creates a new delete request (a request to delete a resource on server).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRowcreateGetRequestname

createGetRequest(url)

dessIndent
Creates a new get request (retrieves whatever information is stored on specified url).
If this url is a https ssl encrypted url which certificates are not in the java certificate store.
(Like a self signed certificate or a none existing root certificate)
Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time.
For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server.
See http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createHeadRequestname

createHeadRequest(url)

dessIndent
Creates a new head request (similar to get request, must not contain body content).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createOptionsRequestname

createOptionsRequest(url)

dessIndent
Creates a new options request (a request for information about communication options).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPatchRequestname

createPatchRequest(url)

dessIndent
Creates a new patch request (used for granular updates).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPostRequestname

createPostRequest(url)

dessIndent
Create a new post request ( Origin server should accept/process the submitted data.)
If this url is a https ssl encrypted url which certificates are not in the java certificate store.
(Like a self signed certificate or a none existing root certificate)
Then for a smart client a dialog will be given, to give the user the ability to accept this certificate for the next time.
For a Web or Headless client the system administrator does have to add that certificate (chain) to the java install on the server.
See http://wiki.servoy.com/display/tutorials/Import+a+%28Root%29+certificate+in+the+java+cacerts+file
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createPutRequestname

createPutRequest(url)

dessIndent
Creates a new put request (similar to post request, contains information to be submitted).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
createTraceRequestname

createTraceRequest(url)

dessIndent
Creates a new trace request (debug request, server will just echo back).
prs

Parameters

sIndenturl ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCookiename

getCookie(cookieName)

dessIndent
Get a cookie by name.
prs

Parameters

sIndentcookieName ;
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
getCookiesname

getCookies()

dessIndent
Get all cookies from this client.
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setClientProxyCredentialsname

setClientProxyCredentials(userName, password)

dessIndent
Set proxy credentials.
prs

Parameters

sIndentuserName ;password ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCookiename

setCookie(cookieName, cookieValue)

dessIndent
Add cookie to the this client.
prs

Parameters

sIndentcookieNamethe name of the cookiecookieValuethe value of the cookie
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCookiename

setCookie(cookieName, cookieValue, domain)

dessIndent
Add cookie to the this client.
prs

Parameters

sIndentcookieNamethe name of the cookiecookieValuethe value of the cookiedomainthe domain
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCookiename

setCookie(cookieName, cookieValue, domain, path)

dessIndent
Add cookie to the this client.
prs

Parameters

sIndentcookieNamethe name of the cookiecookieValuethe value of the cookiedomainthe domainpaththe path
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCookiename

setCookie(cookieName, cookieValue, domain, path, maxAge)

dessIndent
Add cookie to the this client.
prs

Parameters

sIndentcookieNamethe name of the cookiecookieValuethe value of the cookiedomainthe domainpaththe pathmaxAgemaximum age of cookie
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setCookiename

setCookie(cookieName, cookieValue, domain, path, maxAge, secure)

dessIndent
Add cookie to the this client.
prs

Parameters

sIndentcookieNamethe name of the cookiecookieValuethe value of the cookiedomainthe domainpaththe pathmaxAgemaximum age of cookiesecuretrue if it is a secure cookie, false otherwise
ret

Returns

sIndent
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow
setTimeoutname

setTimeout(msTimeout)

dessIndent
Sets a timeout in milliseconds for retrieving of data (when 0 there is no timeout).
prs

Parameters

sIndentmsTimeout ;
clients

Supported Clients

sIndentSmartClient,WebClient,NGClient
sam

Sample

sIdentjavascript
lastDetailRow