| | |
| Property name | Type used | Effect |
|---|
| 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, see the documentation of user agent for more details. |
 Versions 22 and laterAuthToken  New in version 22AuthToken | AuthToken variable | Token for accessing a Webservice that will be used in case of authentication via the OAuth 2.0 protocol. This access token was 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. |
| UploadProgress | httpProgress variable | Notification of progress status when uploading POST data. |
| DownloadProgress | httpProgress variable | Notification of progress status of download. |
Versions 24 and laterClientCertificate New in version 24ClientCertificate ClientCertificate | Character 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>". |
| ContentType | Character string | Type of content of HTTP message that will be sent to the server. This property is taken into account only if the send method (..Method) 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".
|
| Content | Buffer | HTTP message that will be sent to the server. This property is taken into account only if the send method (..Method) 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. |
Versions 25 and laterMaxUploadRate New in version 25MaxUploadRate MaxUploadRate | Integer | Maximum data upload speed, expressed in kilobytes per second. This speed is given for information only.
0 (default value) means that this speed is not limited. |
Versions 25 and laterMaxDownloadRate New in version 25MaxDownloadRate MaxDownloadRate | Integer | Maximum data download speed, expressed in kilobytes per second. This speed is given for information only.
0 (default value) means that this speed is not limited. |
Versions 24 and laterDestination New in version 24Destination Destination | Character string | Full path of the backup file of the HTTP request result. |
| Timeout | Integer ou Duration | Maximum response time-out (expressed in milliseconds). This property can correspond to: - an integer corresponding to the number of milliseconds,
- a Duration variable,
Versions 23 and laterthe direct indication of duration ('1s' or '10ms' for example). New in version 23the direct indication of duration ('1s' or '10ms' for example). the direct indication of duration ('1s' or '10ms' for example).
This property is set to 20 seconds by default. Remark: The timeout defined by HTTPTimeOut has no influence on this property. |
| Header | Associative array of character strings | Key/Value set of headers to send. Example for using 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.
Versions 21 and laterhttpIgnoreRedirection: The redirection to a page is ignored. New in version 21httpIgnoreRedirection: The redirection to a page 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.
Versions 22 and later New in version 22 |
| Method | Integer constant | HTTP method used: - httpCopy: COPY method.
- httpDelete: DELETE method.
- httpGet: GET method.
- httpHead: HEAD method.
Versions 25 and laterhttpLock: Lock method (WebDAV protocol). New in version 25httpLock: Lock method (WebDAV protocol). httpLock: Lock method (WebDAV protocol). Versions 25 and laterhttpMkCol: MkCol method (WebDAV protocol). New in version 25httpMkCol: MkCol method (WebDAV protocol). httpMkCol: MkCol method (WebDAV protocol).Versions 25 and laterhttpMove: Move method (WebDAV protocol). New in version 25httpMove: Move method (WebDAV protocol). httpMove: Move method (WebDAV protocol).- httpPatch: PATCH method.
- httpPost: POST method.
Versions 25 and laterhttpPropFind: PROPFIND method (WebDAV protocol). New in version 25httpPropFind: PROPFIND method (WebDAV protocol). httpPropFind: PROPFIND method (WebDAV protocol).Versions 25 and laterhttpPropPatch: PROPPATCH method (WebDAV protocol). New in version 25httpPropPatch: PROPPATCH method (WebDAV protocol). httpPropPatch: PROPPATCH method (WebDAV protocol).- httpPut: PUT method.
Versions 25 and laterhttpUnlock: Unlock method (WebDAV protocol). New in version 25httpUnlock: Unlock method (WebDAV protocol). httpUnlock: Unlock method (WebDAV protocol).
If ..Content is not empty, the httpPost method is used by default. Otherwise, the httpGet method is used. |
| Password | Character string | Password associated with the user name (empty string by default). Used to access a page with a protected URL. Caution: The password is not encrypted when it is sent on Internet. Remark: If ..UserName and ..Password are specified, the corresponding "Authorization:Basic" is automatically generated in the request header. |
Versions 24 and laterClientCertificatePassword New in version 24ClientCertificatePassword ClientCertificatePassword | Character string | Password associated with the client certificate (empty string by default) |
Versions 24 and laterProcedureTrace New in version 24ProcedureTrace ProcedureTrace | Procedure | Name of WLanguage procedure used to know the headers and the data that have been sent. 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:
- httpTraceHeaderSent: Header.
- httpTraceDataSent: Data.
- <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: ", ...
UTF8ToString(bufByData))
CASE httpTraceDataSent:
Trace("Data: ", ...
bufByData)
END
|
Versions 21 and laterConnectionTimeout New in version 21ConnectionTimeout ConnectionTimeout | Integer ou Duration | Maximum time-out 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,
Versions 23 and laterthe direct indication of duration (20 s or 20000 ms for example). New in version 23the direct indication of duration (20 s or 20000 ms for example). the direct indication of duration (20 s or 20000 ms for example).
If the connection was not established after this time-out, the connection failed ( HTTPSend will return an error, found in the httpResponse variable). |
| 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 (see HTTPParameter for more details).
|
| 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 ..User and ..Password are specified, the corresponding "Authorization:Basic" is automatically generated in the request header. |
Versions 22 and laterVersionSSL New in version 22VersionSSL VersionSSL | Integer constant | SSL version used: - ProtocolDefault: Default protocol (TLS 1.2).
- ProtocolTLS1: TLS1 protocol.
- ProtocolTLS1_1: TLS1.1 protocol.
- ProtocolTLS1_2: TLS1.2 protocol.
|