Child pages
  • PutRequest

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Wiki Markup
{hidden}
DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY, UNLESS YOU KNOW WHAT YOU'RE DOING.
		THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO EXTRACT CHANGES FROM THE PAGE AND MERGE THEM BACK INTO SERVOY SOURCE{hidden}
{sub-section:description|text=}{sub-section}\\ 

{table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px|width=80px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[Boolean]{td}{td}[#addHeader]\(headerName, value)
Add a header to the request.{td}{tr}{tbody}{tbody}{tr}{td}[Response]void{td}{td}[#executeRequest#executeAsyncRequest]\(userName, password, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous.{td}{tr}{tbody}{tbody}{tr}{td}[Response]void{td}{td}[#executeRequest#executeAsyncRequest]\(userNamesuccessCallbackMethod, passworderrorCallbackMethod)
Execute the request method asynchronous.{td}{tr}{tbody}{tbody}{tr}{td}void[Response]{td}{td}[#setBodyContent#executeRequest]\(s)
SetExecute the body of the requestrequest method.{td}{tr}{tbody}{tbody}{tr}{td}void[Response]{td}{td}[#setCharset#executeRequest]\(charsetuserName, password)
SetExecute the charset used when postingrequest method.{td}{tr}{tbody}{tbody}{tr}{td}[Boolean]void{td}{td}[#setBodyContent]\(s)
Set the body of the request.{td}{tr}{tbody}{tbody}{tr}{td}[#setFilevoid{td}{td}[#setCharset]\(filePathcharset)
Set athe charset fileused towhen putposting.{td}{tr}{tbody}{tbody}{tr}{table}\\ 

{table:id=function|class=servoy sDetail}{colgroup}{column:padding=0px|width=100%}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=addHeadertd}[Boolean]{td}{td}[#setFile]\(filePath)
Set a file to put.{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=addHeader|class=node}{tr:id=name}{td}h6.addHeader{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}addHeader{span}{span:id=iets|style=float: left;}\(headerName, value){span}{td}{tr}{tr:id=des}{td}{sub-section:addHeader_des|trigger=button|text=}{sub-section}{sub-section:addHeader_des|trigger=none|class=sIndent}Add a header to the request.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addHeader_snc|trigger=button|text=}{sub-section}{sub-section:addHeader_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addHeader_prs|trigger=button|text=}{sub-section}{sub-section:addHeader_prs|trigger=none|class=sIndent}\{[String]} headerName
\{[String]} value
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addHeader_ret|trigger=button|text=}{sub-section}{sub-section:addHeader_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addHeader_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addHeader_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addHeader_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addHeader_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addHeader_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:addHeader_sam|trigger=none}{code:language=javascript}
method.addHeader('Content-type','text/xml; charset=ISO-8859-1')
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeAsyncRequest-String_String_Function_Function|class=node}{tr:id=name}{td}h6.executeAsyncRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}executeAsyncRequest{span}{span:id=iets|style=float: left;}\(userName, password, successCallbackMethod, errorCallbackMethod){span}{td}{tr}{tr:id=des}{td}{sub-section:executeAsyncRequest-String_String_Function_Function_des|trigger=button|text=}{sub-section}{sub-section:executeAsyncRequest-String_String_Function_Function_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:executeAsyncRequest-String_String_Function_Function_snc|trigger=button|text=}{sub-section}{sub-section:executeAsyncRequest-String_String_Function_Function_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:executeAsyncRequest-String_String_Function_Function_prs|trigger=button|text=}{sub-section}{sub-section:executeAsyncRequest-String_String_Function_Function_prs|trigger=none|class=sIndent}\{[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
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:executeAsyncRequest-String_String_Function_Function_ret|trigger=button|text=}{sub-section}{sub-section:executeAsyncRequest-String_String_Function_Function_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:executeAsyncRequest-String_String_Function_Function_see|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:executeAsyncRequest-String_String_Function_Function_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:executeAsyncRequest-String_String_Function_Function_link|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:executeAsyncRequest-String_String_Function_Function_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:executeAsyncRequest-String_String_Function_Function_sam|trigger=button|text=}{sub-section}{div:class=sIndent}{sub-section:executeAsyncRequest-String_String_Function_Function_sam|trigger=none}{code:language=javascript}
var response = method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeAsyncRequest-Function_Function|class=node}{tr:id=name}{td}h6.addHeaderexecuteAsyncRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]void{span}{span:id=iets|style=float: left; font-weight: bold;}addHeaderexecuteAsyncRequest{span}{span:id=iets|style=float: left;}\(headerNamesuccessCallbackMethod, valueerrorCallbackMethod){span}{td}{tr}{tr:id=des}{td}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:addHeader_des|trigger=none|class=sIndent}Add a header to the requestsection:executeAsyncRequest-Function_Function_des|trigger=none|class=sIndent}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.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_prs|trigger=none|class=sIndent}\{[StringFunction]} headerNamesuccessCallbackMethod -- callbackMethod to be called after response is received
\{[StringFunction]} valueerrorCallbackMethod -- callbackMethod to be called if request errors out
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_ret|trigger=none|class=sIndent}[Boolean]void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:addHeaderexecuteAsyncRequest-Function_Function_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:addHeaderexecuteAsyncRequest-Function_Function_sam|trigger=none}{code:language=javascript}
method.addHeader('Content-type','text/xml; charset=ISO-8859-1'var response = method.executeAsyncRequest(globals.successCallback,globals.errorCallback)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeRequest|class=node}{tr:id=name}{td}h6.executeRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Response]{span}{span:id=iets|style=float: left; font-weight: bold;}executeRequest{span}{span:id=iets|style=float: left;}\(){span}{td}{tr}{tr:id=des}{td}{sub-section:executeRequest_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest_des|trigger=none|class=sIndent}Execute the request method.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:executeRequest_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=prs}{td}*Parameters*\\{sub-section:executeRequest_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest_prs|trigger=none|class=sIndent}{sub-section}{td}{tr}{builder-show}{tr:id=ret}{td}*Returns*\\{sub-section:executeRequest_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest_ret|trigger=none|class=sIndent}[Response]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:executeRequest_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:executeRequest_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:executeRequest_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest_sam|trigger=none}{code:language=javascript}
var response = method.executeRequest()
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=executeRequest-String_String|class=node}{tr:id=name}{td}h6.executeRequest{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Response]{span}{span:id=iets|style=float: left; font-weight: bold;}executeRequest{span}{span:id=iets|style=float: left;}\(userName, password){span}{td}{tr}{tr:id=des}{td}{sub-section:executeRequest-String_String_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest-String_String_des|trigger=none|class=sIndent}Execute the request method.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:executeRequest-String_String_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest-String_String_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:executeRequest-String_String_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest-String_String_prs|trigger=none|class=sIndent}\{[String]} userName -- the user name
\{[String]} password -- the password
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:executeRequest-String_String_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:executeRequest-String_String_ret|trigger=none|class=sIndent}[Response]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:executeRequest-String_String_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest-String_String_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:executeRequest-String_String_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest-String_String_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:executeRequest-String_String_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:executeRequest-String_String_sam|trigger=none}{code:language=javascript}
var response = method.executeRequest()
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setBodyContent|class=node}{tr:id=name}{td}h6.setBodyContent{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setBodyContent{span}{span:id=iets|style=float: left;}\(s){span}{td}{tr}{tr:id=des}{td}{sub-section:setBodyContent_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setBodyContent_des|trigger=none|class=sIndent}Set the body of the request.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setBodyContent_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:setBodyContent_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setBodyContent_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setBodyContent_prs|trigger=none|class=sIndent}\{[String]} s
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setBodyContent_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setBodyContent_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setBodyContent_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setBodyContent_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setBodyContent_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setBodyContent_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setBodyContent_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setBodyContent_sam|trigger=none}{code:language=javascript}
method.setBodyContent(content)
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setCharset|class=node}{tr:id=name}{td}h6.setCharset{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}void{span}{span:id=iets|style=float: left; font-weight: bold;}setCharset{span}{span:id=iets|style=float: left;}\(charset){span}{td}{tr}{tr:id=des}{td}{sub-section:setCharset_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setCharset_des|trigger=none|class=sIndent}Set the charset used when posting. If this is null or not called it will use the default charset (UTF\-8).{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setCharset_snc|text=snc|trigger=button|text=}{sub-section}{sub-section:setCharset_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setCharset_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setCharset_prs|trigger=none|class=sIndent}charset
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setCharset_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setCharset_ret|trigger=none|class=sIndent}void{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setCharset_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setCharset_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setCharset_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setCharset_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setCharset_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setCharset_sam|trigger=none}{code:language=javascript}
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
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setFile|class=node}{tr:id=name}{td}h6.setFile{td}{tr}{tr:id=sig}{td}{span:style=float: left; margin-right: 5px;}[Boolean]{span}{span:id=iets|style=float: left; font-weight: bold;}setFile{span}{span:id=iets|style=float: left;}\(filePath){span}{td}{tr}{tr:id=des}{td}{sub-section:setFile_des|texttrigger=button|triggertext=button}{sub-section}{sub-section:setFile_des|trigger=none|class=sIndent}Set a file to put.{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=snc}{td}*Since*\\{sub-section:setFile_snc|texttrigger=button|triggertext=button}{sub-section}{sub-section:setFile_snc|trigger=none|class=sIndent} Replace with version info{sub-section}{td}{tr}{builder-show}{tr:id=prs}{td}*Parameters*\\{sub-section:setFile_prs|texttrigger=button|triggertext=button}{sub-section}{sub-section:setFile_prs|trigger=none|class=sIndent}\{[String]} filePath
{sub-section}{td}{tr}{tr:id=ret}{td}*Returns*\\{sub-section:setFile_ret|texttrigger=button|triggertext=button}{sub-section}{sub-section:setFile_ret|trigger=none|class=sIndent}[Boolean]{sub-section}{td}{tr}{builder-show:permission=edit}{tr:id=see}{td}*Also see*\\{sub-section:setFile_see|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setFile_see|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{builder-show:permission=edit}{tr:id=link}{td}*External links*\\{sub-section:setFile_link|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setFile_link|trigger=none}{sub-section}{div}{td}{tr}{builder-show}{tr:id=sam}{td}*Sample*\\{sub-section:setFile_sam|texttrigger=button|triggertext=button}{sub-section}{div:class=sIndent}{sub-section:setFile_sam|trigger=none}{code:language=javascript}
putRequest.setFile('c:/temp/manual_01a.doc')
{code}{sub-section}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}