DeleteRequest
Overview
The DeleteRequest
object facilitates the creation and execution of HTTP DELETE requests, offering configurable parameters, headers, and authentication options. It supports both synchronous and asynchronous workflows while accommodating authentication needs like preemptive authentication and domain-based mechanisms.
Asynchronous execution options enable efficient response and error handling through callbacks, while support for enforcing formats such as multipart/form-data
enhances compatibility with various server requirements.
Methods Summarized
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
Add a header to the request.
Add a parameter to the post.
Add a parameter to the post.
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
void
Execute the request method asynchronous.
void
Execute the request method asynchronous using windows authentication.
void
Execute the request method asynchronous.
void
Execute the request method asynchronous using windows authentication.
void
Execute the request method asynchronous.
void
Execute the request method asynchronous using windows authentication.
Execute the request method.
Execute the request method.
Execute a request method using windows authentication.
void
Force this request to prepare a "Content-Type: multipart/form-data" formatted message even if only one file or only a number of parameter were added to it.
void
Set the body of the request.
void
Set the body of the request and content mime type.
void
Set the charset used when posting.
void
Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent)
Methods Detailed
addFile(parameterName, jsFile)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Sample
addFile(parameterName, jsFile, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Sample
addFile(parameterName, fileName, jsFile)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Sample
addFile(parameterName, fileName, jsFile, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Sample
addFile(parameterName, fileName, fileLocation)
Add a file to the post; it will try to get the correct mime type from the file name or the first bytes.
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or a file and at least a parameter via addParameter(...).
Parameters
Sample
addFile(parameterName, fileName, fileLocation, mimeType)
Add a file to the post with a given mime type; could also be used to force the default 'application/octet-stream' on it, because this plugin will try to guess the correct mime type for the given file otherwise (based on the name or the bytes).
If you add a single file then this will be a single file (so not a multi-part) post. If you want/need multi-part then you have to either add multiple files or both a file and one or more parameters using addParameter(...).
Parameters
Sample
addHeader(headerName, value)
Add a header to the request.
Parameters
Sample
addParameter(name, value)
Add a parameter to the post.
If there is also at least one file added to this request using addFile(...) then a multi-part post will be generated.
Parameters
Sample
addParameter(name, value, mimeType)
Add a parameter to the post.
If there is also at least one file added to this request using addFile(...) then a multi-part post will be generated. The multipart element will also contain content-type header, set from mimeType and charset. By default, this header is not present.
Parameters
Sample
executeAsyncRequest()
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the Promise is rejected with exception message as the value.
You can use Promise.all([promise1, promise2, promise3]) to wait for multiple promises to complete. A shortcut for this would be to use httpClient.executeRequest(requestArray) that returns 1 promise that is called when all of them are done.
Sample
executeAsyncRequest(username, password)
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the Promise is rejected with exception message as the value.
You can use Promise.all([promise1, promise2, promise3]) to wait for multiple promises to complete. A shortcut for this would be to use httpClient.executeRequest(requestArray) that returns 1 promise that is called when all of them are done.
Parameters
Sample
executeAsyncRequest(username, password, workstation, domain)
Execute the request method asynchronous a Promise is returned which will be resolved or rejected when the request is completed or failed.
This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the Promise is rejected with exception message as the value.
You can use Promise.all([promise1, promise2, promise3]) to wait for multiple promises to complete. A shortcut for this would be to use httpClient.executeRequest(requestArray) that returns 1 promise that is called when all of them are done.
Parameters
Sample
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod)
Execute the request method asynchronous. Success callback method will be called when response is received. Response is sent as parameter in callback. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
Returns: void
Sample
executeAsyncRequest(username, password, workstation, domain, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
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 followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
Returns: void
Sample
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. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
Returns: void
Sample
executeAsyncRequest(username, password, successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
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 followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
Returns: void
Sample
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. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out), the errorCallbackMethod is called with exception message as parameter.
Parameters
Returns: void
Sample
executeAsyncRequest(successCallbackMethod, errorCallbackMethod, callbackExtraArgs)
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 followed by any 'callbackExtraArgs' that were given. This Response can be a response with a different status code then just 200, it could also be 500, which is still a valid response from the server, this won't go into the error callback. So you need to test the Reponse.getStatusCode() for that to know if everything did go OK. If no response is received (request errors out, network errors), the errorCallbackMethod is called with exception message as parameter followed by any 'callbackExtraArgs' that were given.
Parameters
Returns: void
Sample
executeRequest()
Execute the request method.
Sample
executeRequest(userName, password)
Execute the request method.
Parameters
Sample
executeRequest(userName, password, workstation, domain)
Execute a request method using windows authentication.
Parameters
Sample
forceMultipart(forceMultipart)
Force this request to prepare a "Content-Type: multipart/form-data" formatted message even if only one file or only a number of parameter were added to it.
It is useful because some servers require this (they only support multipart - even if you don't need to send multiple things). Before Servoy 2021.03 you could force it to send multipart by adding a dummy parameter together with a single file (or the other way around) - if the server didn't object to that dummy content...
Default value: false. (if you only add one file or only parameters it will not generate a multipart request)
Parameters
Returns: void
setBodyContent(content)
Set the body of the request.
Parameters
Returns: void
Sample
setBodyContent(content, mimeType)
Set the body of the request and content mime type.
Parameters
Returns: void
Sample
setCharset(charset)
Set the charset used when posting. If this is null or not called it will use the default charset (UTF-8).
Parameters
Returns: void
Sample
usePreemptiveAuthentication(b)
Whatever to use preemptive authentication (sending the credentials in the header, avoiding the server request to the client - useful when uploading files, as some http servers would cancel the first request from the client, if too big, as the authentication request to the client was not yet sent)
Parameters
Returns: void
Last updated
Was this helpful?