The HTTPClient object is a base object for sending HTTP requests and receiving HTTP responses from a resource identified by a URI. Compared to the Inet object, the HTTPClient object is easier to use and supports more methods (Get/Post/Put/Delete) and more SSL protocols (TLS 1.0, TLS 1.1, TLS 1.2, SSL 2.0, and SSL 3.0).
Note
It is not recommended to use this object to process large data (20 MB or 100,000 data rows can be considered as large data based on our tests), because this object will call a third-party library which is memory intensive. If you want to process large data using HTTPClient, it is recommended that you disable the AutoReadData property (by default it is enabled) and use the ReadData function. See a code example in ReadData for how to process large data.
Note
This object cannot be referenced in .NET Web Service or .NET Assembly components, otherwise the component will fail to be deployed.
HTTPClient property |
Datatype |
Description |
---|---|---|
Boolean |
Whether to read the response body automatically. |
|
Boolean |
Checks if the server certificate is revoked. |
|
Integer |
Ignores certain error(s) of the server certificate. |
|
Integer |
The secure protocol. |
|
Long |
The timeout seconds. |
|
ClassDefinition |
PowerObject |
An object of type PowerObject containing information about the class definition of the object or control. |
HTTPClient event |
Occurs |
---|---|
Immediately before the Open event occurs in the window. |
|
Immediately after the Close event occurs in the window. |
HTTPClient function |
Datatype returned |
Description |
---|---|---|
String |
Returns the name assigned to the object. |
|
Integer |
Clears the headers of the request. |
|
Integer |
Creates a reference to a context-specific instance of the specified service. |
|
PowerObject |
Returns a reference to the name of the parent object. |
|
String |
Gets the request header by name. |
|
String |
Gets all of the request headers' information. |
|
Integer |
Gets the response body. |
|
String |
Gets the response header by name. |
|
String |
Gets all of the response headers' information. |
|
Long |
Gets the response status code. |
|
String |
Gets the response status description. |
|
Integer |
Sends the data with POST method. |
|
Integer |
Finishes sending the data with POST method. |
|
Integer |
Starts sending the data with POST method. |
|
Boolean |
Adds an event to the end of the message queue for the object. |
|
Integer |
Reads the response body. |
|
Integer |
Sends the request to the server. |
|
Integer |
Sets the request header. |
|
Integer |
Sets all of the request headers' information. |
|
Integer |
Triggers a specific event in the object and executes the script for the event. |
|
Object |
Returns the type of the object. |