HTTPClient object

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

This object cannot be referenced in .NET Web Service or .NET Assembly components, otherwise the component will fail to be deployed.

Properties

HTTPClient property

Datatype

Description

AutoReadData

Boolean

Whether the program reads the response body automatically.

SecureProtocol

Integer

The secure protocol.

TimeOut

Long

The timeout seconds.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.


Events

HTTPClient event

Occurs

Constructor

Immediately before the Open event occurs in the window.

Destructor

Immediately after the Close event occurs in the window.


Functions

HTTPClient function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object.

ClearRequestHeaders

Integer

Clears the headers of the request.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

GetRequestHeader

String

Gets the request header by name.

GetRequestHeaders

String

Gets all of the request headers' information.

GetResponseBody

Integer

Gets the response body.

GetResponseHeader

String

Gets the response header by name.

GetResponseHeaders

String

Gets all of the response headers' information.

GetResponseStatusCode

Long

Gets the response status code.

GetResponseStatusText

String

Gets the response status description.

PostData

Integer

Sends the data with POST method.

PostDataEnd

Integer

Finishes sending the data with POST method.

PostDataStart

Integer

Starts sending the data with POST method.

PostEvent

Boolean

Adds an event to the end of the message queue for the object.

ReadData

Integer

Reads the response body.

SendRequest

Integer

Sends the request to the server.

SetRequestHeader

Integer

Sets the request header.

SetRequestHeaders

Integer

Sets all of the request headers' information.

TriggerEvent

Integer

Triggers a specific event in the object and executes the script for the event.

TypeOf

Object

Returns the type of the object.