| | |
| Property name | Type used | Effect |
|---|
| AuthToken | AuthToken variable | Token for accessing a Webservice that will be used in case of authentication via the OAuth 2.0 protocol. This access token is retrieved by AuthIdentify. The access token is automatically passed to the access_token parameter on the URL. If the parameter must be different, the http URL to run must be built by yourself. |
| ClientCertificate | String or buffer | Corresponds to: - a character string with an access path to the .p12 file that contains the certificate to attach to the request. The certificate will be automatically loaded taking into account:
- the certificate in the executable library (if it has been integrated into the application),
- the certificate at the specified location on disk (if the certificate has not been integrated into the executable library).
- a buffer with the certificate (fLoadBuffer).
If this property corresponds to an empty string (""), the default certificate is reset to "<None>". |
| ClientCertificatePassword | Character string | Password associated with the client certificate (empty string by default) |
| ConnectionTimeout | Integer ou Duration | Maximum timeout for the connection expressed in milliseconds (20 seconds by default, which means 20000 milliseconds). This property can correspond to: - an integer corresponding to the number of milliseconds,
- a Duration variable,
- the duration in a readable format (e.g., 20 s or 20000 ms).
The connection fails if it cannot be established after this timeout ( HTTPSend will return an error, in the httpResponse result variable). |
| Content | Buffer | HTTP message that will be sent to the server. This property is taken into account only if the sending method (Method property) allows it. The message to send must comply with the HTTP protocol used. By default, if this property is specified and if it is not empty, the method used is a POST request ; otherwise, it is a GET request. |
| ContentType | Character string | Type of the HTTP message content to be sent to the server. This property is taken into account only if the sending method (Method property) allows it. By default, the message type corresponds to: "application/x-www-form-urlencoded". However, you have the ability to use any value, for example: "text/xml", "application/javascript", "application/json", "application/xml", "image/jpeg", ... To send rough data that will be read at once by the WEBDEV Application Server, use the following types: - "application/octet-stream".
- "text/xml".
|
| Destination | Character string | Full path of the backup file of the HTTP request result. |
| DownloadProgress | httpProgress variable | Data reception progress notification. |
| Header | Associative array of character strings | Key/Value set of headers to send. Usage example of this property:
cMyRequest.Header["Authorization"] = ...
" WSSE profile=""UsernameToken"""
cMyRequest.Header["X-WSSE"] = ...
"UsernameToken Username=blahblah "
cMyRequest.Header["Cache-Control"] = " no-cache"
|
| IgnoreError | Integer constant | Specifies the ignored errors. Corresponds to a constant or to a combination of constants:- httpIgnoreInvalidCertificate: The certificate is ignored.
- httpIgnoreInvalidCertificateName: The site name specified in the certificate is ignored.
- httpIgnoreExpiredCertificate: The certificate date is ignored.
- httpIgnoreRedirection: The redirection to a page is ignored.
- httpIgnoreRedirectToHTTP: The redirection to a non-secure server is allowed.
- httpIgnoreRedirectToHTTPS: The redirection to a secure server is allowed.
- httpIgnoreRevocation: The check in the list of revoked certificates is ignored.
|
| MaxDownloadRate | Integer | Maximum data download speed in kilobytes per second. This speed is given for information only.
0 (default value) means that this speed is not limited. |
| MaxUploadRate | Integer | Maximum data upload speed in kilobytes per second. This speed is given for information only.
0 (default value) means that this speed is not limited. |
| Method | Integer constant | HTTP method used: - httpCopy: COPY method (7).
- httpDelete: DELETE method (4).
- httpGet: GET method (1).
- httpHead: HEAD method (5).
- httpLock: LOCK method (12) (WebDAV protocol).
- httpMkCol: MKCOL method (10) (WebDAV protocol).
- httpMove: MOVE method (11) (WebDAV protocol).
- httpPatch: PATCH method (6).
- httpPost: POST method (2).
- httpPropFind: PROPFIND method (8) (WebDAV protocol).
- httpPropPatch: PROPPATCH method (9) (WebDAV protocol).
- httpPut: PUT method (3).
- httpUnlock: UNLOCK (13) (WebDAV protocol).
If the Content property is not empty, the httpPost method is used by default. Otherwise, the httpGet method is used. |
| Password | Character string | Password associated with the username (empty string by default). Used to access a page with a protected URL. Caution: The password is not encrypted when it is sent over the Internet. Remark: If the UserName and Password properties are specified, the corresponding "Authorization:Basic" header is automatically generated in the request header. |
| ProcedureTrace | Procedure | Name of the WLanguage procedure used to identify the data and headers that have been sent and received. This procedure has the following format:
PROCEDURE <Procedure name>(<InfoType> is int,
<Data> is Buffer)
where: - <InfoType> is an integer constant that corresponds to the type of data being traced:
- httpTraceDataSent: Data sent.
- httpTraceDataReceived: Data received.
- httpTraceHeaderSent: Header sent.
- httpTraceHeaderReceived: Header received.
- <Data> is a buffer that contains the information.
Example of procedure:
PROCEDURE ProcTrace(nInfoType is int, ...
bufByData is Buffer)
SWITCH nInfoType
CASE httpTraceHeaderSent
Trace("Header sent: ", ...
UTF8ToString(bufByData))
CASE httpTraceDataSent:
Trace("Data sent: ", ...
bufByData)
CASE httpTraceHeaderReceived:
Trace("Header received: ", ...
UTF8ToString(bufByData))
CASE httpTraceDataReceived:
Trace("Data received: ", ...
bufByData)
END
|
| Boolean | Indicates whether the Content property corresponds to the raw content:- True: the Content property corresponds to a buffer. No modification is performed.
- False (Default value): the content is modified by the browser. In particular, UTF-8 text is automatically decoded. the Content property returns the result as a string.
|
 New in version 28SelectedCipher | Character string | Name of the cipher selected for the secure request. This property is available in read-only mode. |
New in version 28SelectedSSLVersion | Integer constant | SSL version chosen for a secure request: - ProtocolDefault: Default protocol (TLS 1.2).
- ProtocolTLS1: TLS1 protocol.
- ProtocolTLS1_1: TLS1.1 protocol.
- ProtocolTLS1_2: TLS1.2 protocol.
New in version 28ProtocolTLS1_3: TLS1.3 protocol.
This property is available in read-only mode. |
| Timeout | Integer ou Duration | Maximum response timeout (in milliseconds). This property can correspond to: - an integer corresponding to the number of milliseconds,
- a Duration variable,
- the duration in a readable format (e.g., '1s' or '10ms').
This property is set to 20 seconds by default. Remark: The timeout defined by HTTPTimeOut has no influence on this property. |
| UploadProgress | httpProgress variable | Notification of the progress status when uploading POST data. |
| URL | Character string | Address of server to contact (URL address). This URL can contain: - the port number for connecting to the server.
The default value is 80 in HTTP (corresponds to a server of Web pages) and 443 in HTTPS. To specify a port number, use the following format: "<Server URL>:<Port #>". For example: http://www.windev.com:80. - additional parameters. These parameters can be used to perform a search or to fill a form. For example, to find "windev" on "http://www.google.com", the URL to contact will be: "http://www.google.com/search?q=windev".
Remarks:- To specify both the port number and additional parameters, use the following format: "<Server URL>:<Port #>/<Additional parameters>".
- To perform a secure transaction, the URL must start with "https://". In this case, the management mode of requests is always performed by Internet Explorer (for more details, see HTTPConfigure).
|
| User | Character string | Name used to access a page with a protected URL (empty string by default). This name is used to identify the user. Remark: If the User and Password properties are specified, the corresponding "Authorization:Basic" header is automatically generated in the request header. |
| UserAgent | Character string | Identifies the client. By default, the value corresponds to the application name. The response content may depend on the user agent (for example, different pages are required by a request performed from a Palm Pilot and a request performed from a PC browser). In this case, for more details, see the documentation of user agent. |
| VersionHTTP | Integer constant | HTTP version used by the server: - httpVersion2: HTTP version 2.0. If the server does not support this version, an older version is used.
- httpVersion2Only: Forces HTTP version 2.0: if the server does not support this version, a fatal error is displayed.
- httpVersion1_1: HTTP version 1.1.
- httpVersion1_0: HTTP version 1.0.
- httpVersionDefault: HTTP version 1.0.
|
| VersionSSL | Integer constant | Minimum and maximum SSL version supported. To set the minimum and maximum TLS versions to 1.1 and 1.3, simply specify the ProtocolTLS1_1 + ProtocolTLS1_3 constants The following constants can be used: - ProtocolDefault: Default protocol. Maximum version supported (or a lower version if the server does not support this protocol).
- ProtocolTLS1: TLS1 protocol.
- ProtocolTLS1_1: TLS1.1 protocol.
- ProtocolTLS1_2: TLS1.2 protocol.
New in version 28ProtocolTLS1_3: TLS1.3 protocol.
|