Chilkat.Http PHP ActiveX Reference
Chilkat.Http
Class for sending HTTP requests and receiving server responses.
- Supports GET, POST, HEAD, PUT, DELETE, WebDav, and custom HTTP request methods.
- HTTP Authentication: Basic, NTLM, Digest, Negotiate
- HTTPS (SSL/TLS) with client-side certificate capabilities.
- Cookie caching, auto-resend, persisting to XML files.
- Content caching.
- Supports HTTP proxies
- Auto-follow redirects if desired.
- Amazon S3 methods.
- XML HTTP Request
- HTTP file upload capabilities
- Asynchronous features -- putting HTTP requests in background threads.
- Supports SOCK5/SOCKS4 proxies.
- IPv6 capable.
Object Creation
$obj = new COM("Chilkat.Http");
Properties
string Accept
The Accept header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "*/*".
string AcceptCharset
The AcceptCharset header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "ISO-8859-1,utf-8;q=0.7,*;q=0.7".
string AcceptLanguage
The AcceptLanguage header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "en-us,en;q=0.5".
int AllowGzip
Controls whether the "Accept-Encoding: gzip" header is added to HTTP requests sent via any method that sends an HTTP request without using the HttpRequest object (such as QuickGetStr). If false, then the empty Accept-Encoding header is added which means the server response should contain the uncompressed content. The default value is true, which means the server, if it chooses, may send a gzipped response.
bool AutoAddHostHeader
If set to true, the "Host" header field will automatically be added to the request header for any QuickGet or QuickGetStr method calls. The value of the Host header field is taken from the hostname part of the URL passed to QuickGet/QuickGetStr.
string AwsAccessKey
To be documented soon...
string AwsSecretKey
To be documented soon...
string BgLastErrorText (read-only)
When a background-enabled method is run asynchronously in a background thread, the last-error information is saved here and not in the LastErrorText property. If the background method fails, this will contain information about what transpired. (This property also contains information when the background method succeeds.) More information on background enabling HTTP communications. Example for background thread HTTP Download.
int BgPercentDone (read-only)
To be documented soon...
VARIANT BgResultData (read-only)
If a backgrounded method returns a byte array, the returned data is found here.
int BgResultInt (read-only)
If a backgrounded method returns an integer, the return value is found here.
string BgResultString (read-only)
If a backgrounded method returns a string, the return value is found here.
int BgTaskFinished (read-only)
Becomes true when the background method completes. Your application would periodically check for this condition. More information on background enabling HTTP communications. Example for background thread HTTP Download.
int BgTaskRunning (read-only)
If true then the object instance already has a backgrounded method running. Another backgrounded method cannot be started until the 1st completes. (Multiple simultaneous background methods may run by using multiple object instances.)
If false, then no method is currently running in a background thread. More information on background enabling HTTP communications. Example for background thread HTTP Download.
int BgTaskSuccess (read-only)
This property's value is only meaningful (true or false) after a backgrounded method completes. More information on background enabling HTTP communications. Example for background thread HTTP Download.
string ClientIpAddress
The IP address to use for computers with multiple network interfaces or IP addresses.
For computers with a single network interface (i.e. most computers), this property should not be set. For multihoming computers, the default IP address is automatically used if this property is not set.
The IP address is a string such as in dotted notation using numbers, not domain names, such as "165.164.55.124". Important Bind to Adapter Notes for Windows
int ConnectTimeout
The amount of time in seconds to wait before timing out when connecting to an HTTP server.
string Connection
The Connection header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Keep-Alive". To prevent the Connection header from being added to the HTTP header, set this property to the empty string.
string CookieDir
Specifies a directory where cookies are automatically persisted if the Http.SaveCookies property is turned on. Cookies are stored in XML formatted files, one per domain, to main it easy for other programs to understand and parse. May be set to the string "memory" to cache cookies in memory. Saving Cookies to XML Files Caching cookies in-memory.
string DebugLogFilePath
Used for debugging in cases where a Chilkat method call hangs and never returns. This should generally never happen. The only causes for this are (1) a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired, (2) the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or (3) there is an internal problem (bug) in the Chilkat code that causes the hang.
This property allows one to specifiy a debug file path that will be created (or appended if it already exists) and information will be logged to it as the Chilkat methods are called. If a hang occurs, the log file may be viewed to get information about what happened.
int DefaultFreshPeriod
The default freshness period (in minutes) for cached documents when the FreshnessAlgorithm property is set to 0. The default value is 10080 (1 week).
int DigestAuth
Setting this property to true causes the HTTP component to use digest authentication. The default value is false. HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)
int EventLogCount (read-only)
If the KeepEventLog property is set to true, then this property will contain the number of events that have accumulated in the in-memory event log. The events are indexed from 0 to EventLogCount-1. The ClearEventLog method may be called to clear the event log. The name and value of each event can be retrieved via the EventLogName and EventLogValue methods.
bool FetchFromCache
Set to true if pages should be fetched from cache when possible. Only HTTP GET requests are cached. HTTP responses that include Set-Cookie headers are not cached. A page is fetched from the disk cache if it is present and it is "fresh" according to the FreshnessAlgorithm property. If a page exists in cache but is not fresh, the HTTP component will issue a revalidate request and update the cache appropriately according to the response.
string FinalRedirectUrl (read-only)
If an HTTP GET was redirected (as indicated by the WasRedirected property), this property will contain the final redirect URL, assuming the FollowRedirects property is true. Tracing HTTP Redirects
bool FollowRedirects
If true, then 301 and 302 redirects are automatically followed when calling QuickGet and QuickGetStr. FollowRedirects is true by default.
int FreshnessAlgorithm
The freshness algorithm to use when determining the freshness of a cached HTTP GET response. A value of 1 causes an LM-factor algorithm to be used. This is the default. The LMFactor property is a value between 1 and 100 indicating the percentage of time based on the last-modified date of the HTML page. For example, if the LMFactor is 50, and an HTML page was modified 10 days ago, then the page will expire (i.e. no longer be fresh) in 5 days (50% of 10 days). This only applies to HTTP responses that do not have page expiration information. If the FreshnessAlgorithm = 0, then a constant expire time period determined by the DefaultFreshPeriod property is used.
int HeartbeatMs
When set to a non-zero value, it specifies the time interval in milliseconds between AbortCheck events. Any HTTP operation can be aborted via the AbortCheck event. Event callbacks are supported for ActiveX, .NET, and C++ implementations of this API.
bool IgnoreMustRevalidate
Some HTTP responses contain a "Cache-Control: must-revalidate" header. If this is present, the server is requesting that the client always issue a revalidate HTTP request instead of serving the page directly from cache. If IgnoreMustRevalidate is set to true, then Chilkat HTTP will serve the page directly from cache without revalidating until the page is no longer fresh.
The default value of this property is false.
bool IgnoreNoCache
Some HTTP responses contain headers of various types that indicate that the page should not be cached. Chilkat HTTP will adhere to this unless this property is set to true.
The default value of this property is false.
int KeepEventLog
If true, an in-memory event log is kept for any method that communicates with an HTTP server (such as Download, PostUrlEncoded, QuickGetStr, SynchronousRequest, etc.). When HTTP methods are called asynchronously, the event log can be checked while the HTTP operation is in in progress. This is done by examining the EventLogCount property and then fetching each event's name and value via the EventLogName and EventLogValue methods. See this example: Asynchronous HTTP.
The ClearBgEventLog method may be called to clear the in-memory event log.
Important: If event logging is enabled, make sure to clear the event log after each HTTP method call. Otherwise the log will continue to grow without bounds.
The default value of this property is false.
The following items may be found in the event log:
| Name | Value |
|---|
| SocketConnect | hostname:port, called when initiating a connection. |
| SocketConnected | hostname:port, called after successfully connected. |
| HttpProxyConnect | hostname:port |
| SslHandshake | "Starting"/"Finished" |
| HttpGetBegin | URL |
| HttpCacheHit | "Returning page from cache." |
| HttpInfo | various conditions...
"Begin reading response" -- called when beginning to read the response.
"Finished reading response"
"Existing connection with HTTP server no longer open, restarting GET with new connection."
"Reading chunked response."
"UnGzipping response data"
"Connection:close header is present" |
| GetRequest | the full HTTP GET request to be sent to the server. |
| ResponseHeader | the header of the HTTP response. |
| HttpStatusCode | HTTP response status code (integer) |
| ChunkSize | Size (in bytes) of next chunk in response. |
| ResponseContentLength | Non-chunked response size in bytes. |
| UnGzippedLength | If the response was gzip compressed, this is the uncompressed size. |
| HostnameResolve | hostname, Called when starting to resolve a hostname (to an IP address) |
| ResolvedToIp | dotted IP address, called after hostname is resolved. |
| HttpAuth | one of the following strings:
"Starting Negotiate Authentication"
"Starting NTLM Authentication"
"Adding Basic Authentication Header"
"Adding Proxy Authentication Header"
"Starting Proxy NTLM Authentication"
"Starting Digest Authentication" |
| CookieToSend | Value of a Set-Cookie header field to be added to the outgoing request. |
| SavingCookie | XML of cookie being persisted. |
| HttpRedirect | Redirect URL |
| Socks4Connect | domain:port |
| Socks5Connect | domain:port |
| HttpRequestBegin | Verb (such as POST, GET, PUT), domain:port/path |
| RequestHeader | The full HTTP request header to be sent. |
| StartSendingRequest | Size of entire request, including header, in number of bytes. (Not called for QuickGet)
For uploads, this is the size of the entire upload (headers and all files combined) |
| SubPartHeader | The header for one of the parts within a multipart request. |
| UploadFilename | The file about to be uploaded (streamed from file to socket..) |
int LMFactor
An integer between 1 and 100 that indicates the percentage of time from the HTTP page's last-modified date that will be used for the freshness period. The default value is 25. For example, if a page is fetched with a last-modified date of 4 weeks ago, and the LMFactor = 25, then the page will be considered fresh in the cache for 1 week (25% of 4 weeks).
string LastContentType (read-only)
The content-type of the last HTTP response received by the HTTP component.
string LastErrorHtml (read-only)
Error information in HTML format for the last method called.
string LastErrorText (read-only)
Error information in plain-text format for the last method called.
string LastErrorXml (read-only)
Error information in XML format for the last method called.
string LastHeader (read-only)
The text of the last HTTP header sent by any of this class's methods. The purpose of this property is to allow the developer to examine the exact HTTP header for debugging purposes.
string LastModDate (read-only)
The value of the Last-Modified header in the last HTTP response received by the HTTP component.
string LastResponseHeader (read-only)
The entire last response header for the last HTTP response received by the HTTP component.
int LastStatus (read-only)
The last HTTP status value received by the HTTP component. This only applies to methods that do not return an HTTP response object. For methods that return an HTTP response object, such as SynchronousRequest, the status code is found in the StatusCode property of the response object.
string Login
The HTTP login for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true. HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)
string LoginDomain
The optional domain name to be used with NTLM / Kerberos / Negotiate authentication.
int MaxConnections
The maximum number of simultaneous open HTTP connections managed by the HTTP component. The Chilkat HTTP component automatically manages HTTP connections. If the number of open HTTP connections is about to be exceeded, the connection with the least recent activity is automatically closed.
int MaxFreshPeriod
Limits the amount of time a document can be kept "fresh" in the cache. The MaxFreshPeriod is specified in minutes, and the default value is 525600 which is equal to 1 year.
int MaxResponseSize
The maximum HTTP response size to be accepted by the calling program. A value of 0 (the default) indicates that there is no maximum value.
int MaxUrlLen
The Http class will automatically fail any URL longer than this length. The default MaxUrlLen is 800 characters.
bool MimicFireFox
If set to true, then the appropriate headers to mimic Mozilla/FireFox are automatically added to requests sent via the QuickGet and QuickGetStr methods.
bool MimicIE
If set to true, then the appropriate headers to mimic Internet Explorer are automatically added to requests sent via the QuickGet and QuickGetStr methods.
int MinFreshPeriod
The freshness period for a document in cache will not be less than this value (in minutes). The default value is 30.
int NegotiateAuth
Set this property equal to true for Negotiate authentication. Negotiate authentication will dynamically select Kerberos or NTLM authentication depending on what the server requires.
Note: The NegotiateAuth property is only available for the Microsoft Windows operating system. HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)
bool NtlmAuth
Setting this property to true causes the HTTP component to use NTLM authentication (also known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server. The default value is false. HTTP Authentication (Basic, NTLM, Digest, Negotiate/Kerberos)
int NumCacheLevels
The number of directory levels to be used under each cache root. The default is 0, meaning that each cached HTML page is stored in a cache root directory. A value of 1 causes each cached page to be stored in one of 255 subdirectories named "0","1", "2", ..."255" under a cache root. A value of 2 causes two levels of subdirectories ("0..255/0..255") under each cache root. The HTTP control automatically creates subdirectories as needed. The reason for mutliple levels is to alleviate problems that may arise with unrelated software when huge numbers of files are stored in a single directory. For example, Windows Explorer does not behave well when trying to display the contents of directories with thousands of files.
int NumCacheRoots (read-only)
The number of cache roots to be used for the HTTP cache. This allows the disk cache spread out over multiple disk drives. Each cache root is a string indicating the drive letter and directory path. For example, "E:\Cache". An example of a very large low-cost cache might be four USB external drives. To create a cache with four roots, call AddCacheRoot once for each directory root.
string Password
The HTTP password for pages requiring a login/password. Chilkat HTTP can do both Basic and NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To use NTLM, set the NtlmAuth property = true.
string ProxyAuthMethod
Set this to "basic" if you know in advance that Basic authentication is to be used for the HTTP proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The HTTP component will automatically handle proxy authentication for any of the supported authentication methods: NTLM, Digest, or Basic. Setting this property equal to "basic" prevents the 407 response which is automatically handled internal to Chilkat and never seen by your application.
string ProxyDomain
The domain name of a proxy host if an HTTP proxy is used.
string ProxyLogin
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy login.
int ProxyPartialUrl
The default value is false. If false, then the full URL is passed on the start line for HTTP requests (GET, POST, PUT, etc.) using a proxy. If true, then only the path is passed on the start line.
string ProxyPassword
If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy password.
int ProxyPort
The port number of a proxy server if an HTTP proxy is used.
int ReadTimeout
The amount of time in seconds to wait before timing out when reading from an HTTP server. The ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming. During a long download, if the data stream halts for more than this amount, it will timeout. Otherwise, there is no limit on the length of time for the entire download.
string RedirectVerb
Indicates the HTTP verb, such as GET, POST, PUT, etc. to be used for a redirect when the FollowRedirects property is set to true. The default value is an empty string, indicating that the same verb as the original HTTP request should be used.
string Referer
The Referer header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is the empty string which causes the Referer field to be omitted from the request header.
string RequiredContentType
If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the content-type in the response header does not match this setting. If the content-type does not match, only the header of the HTTP response is read, the connection to the HTTP server is closed, and the remainder of the response is never read.
This property is empty (zero-length string) by default.
Some typical content-types are "text/html", "text/xml", "image/gif", "image/jpeg", "application/zip", "application/msword", "application/pdf", etc.
bool SaveCookies
If this property is true, cookies are automatically persisted to XML files in the directory specified by the CookiesDir property (or in memory if CookieDir = "memory"). Both CookiesDir and SaveCookies must be set for cookies to be persisted. Saving Cookies to XML Files Caching cookies in-memory.
int SendBufferSize
The buffer size to be used with the underlying TCP/IP socket for sending. The default value is 65535.
bool SendCookies
If true, then cookies previously persisted to the CookiesDir are automatically added to all HTTP requests. Only cookies matching the domain and path are added. Caching cookies in-memory.
string SessionLogFilename
Enables file-based session logging. If set to a filename (or relative/absolute filepath), then the exact HTTP requests and responses are logged to a file. The file is created if it does not already exist, otherwise it is appended. Debugging HTTP HTTP Session Logging
string SocksHostname
The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only used if the SocksVersion property is set to 4 or 5).
string SocksPassword
The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password, so this does not apply to SOCKS4.
int SocksPort
The SOCKS4/SOCKS5 proxy port. The default value is 1080.
This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4 or 5).
string SocksUsername
The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is set to 4 or 5).
int SocksVersion
SocksVersion
May be set to one of the following integer values:
0 - No SOCKS proxy is used. This is the default.
4 - Connect via a SOCKS4 proxy.
5 - Connect via a SOCKS5 proxy.
string SslProtocol
Selects the secure protocol to be used for secure (SSL) connections. Possible values are:
default
TLS 1.0
SSL 3.0
SSL 2.0
PCT 1.0
The default value is "default", which allows for the protocol to be selected dynamically at runtime based on the requirements of the server.
bool UpdateCache
Controls whether the cache is automatically updated with the responses from HTTP GET requests.
int UseBgThread
If true, then background-enabled methods will run in a background thread. Normally, a method will return after its work is completed. However, when UseBgThread is true, the method will return immediately and a background thread is started to carry out the method’s task.
Background-enabled HTTP methods are:
bool UseIEProxy
If true, the proxy host/port used by Internet Explorer will also be used by Chilkat HTTP.
string UserAgent
The UserAgent header field to be automatically included with GET requests issued by QuickGet or QuickGetStr. The default value is "Chilkat/1.0.0 (+http://www.chilkatsoft.com/ChilkatHttpUA.asp)" which indicates that the software used to issue the HTTP request was the Chilkat HTTP component.
int VerboseLogging
If true, increases the amount of information available in LastErrorText (or LastErrorXml / LastErrorHtml). The default is false.
string Version (read-only)
Returns a string such as "1.0.0" indicating the version of the HTTP component.
bool WasRedirected (read-only)
Indicates whether the last HTTP GET was redirected.
Methods
void AddCacheRoot(string dirPath)
This method must be called at least once if disk caching is to be used. The file path (including drive letter) such as "E:\MyHttpCache\" is passed to AddCacheRoot to specify the root directory. The cache can be spread across multiple disk drives by calling AddCacheRoot multiple times, each with a directory path on a separate disk drive.
bool AddQuickHeader(string headerFieldName, string headerFieldValue)
Adds a custom header field to any HTTP request sent by a method that does not use the HTTP request object. These methods include Download, DownloadAppend, GetHead, PostBinary, PostMime, PostXml, PutBinary, PutText, QuickDeleteStr, QuickGet, QuickGetObj, QuickGetStr, QuickPutStr, XmlRpc, and XmlRpcPut.
Cookies may be explictly added by calling this method passing "Cookie" for the headerFieldName.
The RemoveQuickHeader method can be called to remove a custom header. Adding Cookies to an HTTP Request
Chilkat.HttpResponse BgResponseObject()
If a backgrounded method returns an Http response object, it may be retrieved by calling this method.
void BgTaskAbort()
Call this to force the currently running backgrounded method to abort.
void ClearBgEventLog()
Clears the in-memory event log (which is enabled by setting the KeepEventLog property = true).
void ClearInMemoryCookies()
Clears all cookies cached in memory. Calling this only makes sense if the CookieDir property is set to the string "memory".
int CloseAllConnections()
Closes all connections still open from previous HTTP requests.
An HTTP object instance will maintain up to 10 connections. If the HTTP server's response does not include a "Connection: Close" header, the connection will remain open and will be re-used if possible for the next HTTP request to the same hostname:port. (It uses the IP address (in string form) or the domain name, whichever is used in the URL provided by the application.)
If 10 connections are already open and another is needed, the object will close the least recently used connection.
bool Download(string url, string filename)
HTTP downloads a file at a URL. The file can be any size and any type. Large files are downloaded in streaming mode such that the memory footprint is small and steady. HTTPS is fully supported, as it is with all the methods of this class. Returns 1 for success, 0 for failure. HTTP Download any Type of File (binary or text) Debugging HTTP
bool DownloadAppend(string url, string filename)
Same as the Download method, but the output file is open for append. Returns 1 for success, 0 for failure.
string DownloadHash(string url, string hashAlgorithm, string encoding)
To be documented soon...
string EventLogName(int index)
Returns the name of the Nth event in the in-memory event log. Refer to the documentation for the KeepEventLog property for the full list of event names. Indexing is from 0 to EventLogCount-1. Returns a null on failure
string EventLogValue(int index)
Returns the value of the Nth event in the in-memory event log. Indexing is from 0 to EventLogCount-1. Returns a null on failure
string ExtractMetaRefreshUrl(string html)
To be documented soon...
string GenTimeStamp()
Returns the current GMT (also known as UTC) date/time in a string that is compliant with RFC 2616 format. Returns a null on failure
string GetCacheRoot(int index)
Returns the Nth cache root (indexing begins at 0). Cache roots are set by calling AddCacheRoot one or more times. Returns a null on failure
string GetCookieXml(string domain)
Returns the cookies in XML format for a specific domain. Cookies are only persisted if the SaveCookies property is set to true. If the CookieDir property is set to the keyword "memory", then cookies are saved in-memory. Returns a null on failure
string GetDomain(string url)
Utility method for extracting the domain name from a full URL. For example, if "http://www.chilkatsoft.com/default.asp" is the URL passed in, then "www.chilkatsoft.com" is returned. Returns a null on failure
Chilkat.HttpResponse GetHead(string url)
Sends an HTTP HEAD request for a URL and returns a response object.
string GetRequestHeader(string name)
Returns the value of a header field that has been pre-defined to be sent with all HTTP GET requests issued by the QuickGet and QuickGetStr methods. By default, this includes header fields such as Accept, AcceptCharset, AcceptLanguage, Connection, UserAgent, etc. Returns a null on failure
Chilkat.Cert GetServerSslCert(string domain, int port)
Establishes an SSL/TLS connection with a web server for the purpose of retrieving the server's SSL certificate (public-key only of course...). Nothing is retrieved from the web server. This method simply makes a connection, gets the certificate information, and closes the connection.
string GetUrlPath(string url)
Returns the path part of a URL. The syntax of a URL is ://:@:/;?#. This method returns the "path" part. Returns a null on failure
bool HasRequestHeader(string name)
Returns true if the specified header field is defined such that it will be sent with all GET requests issued by the QuickGet and QuickGetStr methods.
bool IsUnlocked()
Returns true if the Http class has been unlocked. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period.
string PostBinary(string url, VARIANT byteData, string contentType, int md5, int gzip)
To be documented soon...
Chilkat.HttpResponse PostJson(string url, string jsonText)
A simplified way of sending a JSON POST and receiving the JSON response. The HTTP response is returned in an HTTP response object. HTTP POST JSON
Chilkat.HttpResponse PostMime(string url, string mime)
Allows the calling application to specify the exact content to be sent in a POST. The HTTP POST is sent and the response is returned as an HTTP response object. Debugging HTTP
Chilkat.HttpResponse PostUrlEncoded(string url, Chilkat.HttpRequest req)
Sends a simple URL encoded POST. The form parameters are sent in the body of the HTTP request in x-www-form-urlencoded format. The content-type is "application/x-www-form-urlencoded". Duplicating a Simple HTML Form Submission (POST) HTTP POST x-www-form-urlencoded Debugging HTTP
Chilkat.HttpResponse PostXml(string endpointUrl, string xmlContent, string xmlCharset)
A simplified way of posting XML content to a web server. This method is good for making SOAP calls using HTTP POST. The xmlCharset should match the character encoding used in the xmlContent, which is typically "utf-8". The HTTP response is returned in an HTTP response object. Send XMLHttpRequest and Get Response Calling a SOAP Web Service using PostXml Debugging HTTP
string PutBinary(string url, VARIANT byteData, string contentType, int md5, int gzip)
Sends an HTTP PUT request to the url. The body of the HTTP request is byteData. The contentType is a content type such as "image/gif", "application/pdf", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the byteData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the byteData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server). Returns a null on failure
string PutText(string url, string textData, string charset, string contentType, int md5, int gzip)
Sends an HTTP PUT request to the url. The body of the HTTP request is textData. The charset should be set to a charset name such as "iso-8859-1", "windows-1252", "Shift_JIS", "utf-8", etc. The string "ansi" may also be used as a charset name. The contentType is a content type such as "text/plain", "text/xml", etc. If md5 is true, then a Content-MD5 header is added with the base64 MD5 hash of the textData. Servers aware of the Content-MD5 header will perform a message integrity check to ensure that the data has not been corrupted. If gzip is true, the textData is compressed using the gzip algorithm. The HTTP request body will contain the GZIP compressed data, and a "Content-Encoding: gzip" header is automatically added to indicate that the request data needs to be ungzipped when received (at the server). Returns a null on failure
string QuickDeleteStr(string url)
Same as QuickGetStr, but uses the HTTP DELETE method instead of the GET method. Returns a null on failure Debugging HTTP
VARIANT QuickGet(string url)
Sends an HTTP GET request for a URL and returns the response body as a byte array. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page may be fetched directly from cache. Because the URL can specify any type of resource (HTML page, GIF image, etc.) the return value is a byte array. If the resource is known to be a string, such as with an HTML page, you may call QuickGetStr instead. If the HTTP request fails, a zero-length byte array is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties. Returns 1 for success, 0 for failure.
Chilkat.HttpResponse QuickGetObj(string url)
To be documented soon.
string QuickGetStr(string url)
Sends an HTTP GET request for a URL and returns the response body as a string. The URL may contain query parameters. If the SendCookies property is true, matching cookies previously persisted to the CookiesDir are automatically included in the request. If the FetchFromCache property is true, the page could be fetched directly from cache. If the HTTP request fails, a NULL value is returned and error information can be found in the LastErrorText, LastErrorXml, or LastErrorHtml properties. Returns a null on failure HTTP GET - Download HTML or any Text Content to a String HTTPS GET using SSL/TLS
string QuickPutStr(string url)
Same as QuickGetStr, but uses the HTTP PUT method instead of the GET method. Returns a null on failure Debugging HTTP
bool RemoveQuickHeader(string headerFieldName)
Removes a header from the internal list of custom header field name/value pairs to be automatically added when HTTP requests are sent via methods that do not use the HTTP request object. (The AddQuickHeader method is called to add custom header fields.)
void RemoveRequestHeader(string name)
Eliminates a header field from being included in HTTP GET requests issued by the QuickGet and QuickGetStr methods.
string RenderGet(string url)
Same as QuickGet, but does not send the HTTP GET. Instead, it builds
the HTTP request that would've been sent and returns it. Returns a null on failure
bool ResumeDownload(string url, string targetFilename)
Same as the Download method, except a failed download may be resumed. The targetFilename is automatically checked and if it exists, the download will resume at the point where it previously failed. ResumeDownload may be called any number of times until the full download is complete. Returns 1 for success, 0 for failure.
int S3_CreateBucket(string bucketPath)
Creates a new Amazon S3 bucket. Returns 1 for success, 0 for failure. S3 Create Bucket Example
int S3_DeleteBucket(string bucketPath)
Deletes an Amazon S3 bucket. S3 Delete Bucket
int S3_DeleteObject(string bucketPath, string objectName)
Deletes a remote file (object) on the Amazon S3 service. Returns 1 for success, 0 for failure. S3 Delete File
VARIANT S3_DownloadBytes(string bucketPath, string objectName)
The same as DownloadFile, except the file data is returned directly in-memory instead of being written to a local file. Returns 1 for success, 0 for failure.
bool S3_DownloadFile(string bucketPath, string objectName, string localFilePath)
Downloads a file from the Amazon S3 service. Returns 1 for success, 0 for failure. S3 Download File Example
string S3_DownloadString(string bucketPath, string objectName, string charset)
Downloads a text file (object) from the Amazon S3 service directly into a string variable. The charset specifies the character encoding, such as "utf-8", of the remote text object. Returns a null on failure S3 Download String Object
string S3_ListBucketObjects(string bucketPath)
Retrieves the XML listing of the objects contained within an Amazon S3 bucket. (This is like a directory listing, but in XML format.) Returns a null on failure S3 List Objects in Bucket
string S3_ListBuckets()
Retrieves the XML listing of the buckets for an Amazon S3 account. Returns a null on failure S3 List Buckets Example
int S3_UploadBytes(VARIANT contentBytes, string contentType, string bucketPath, string objectName)
The same as S3_UploadFile, except the contents of the file come from contentBytes instead of a local file. Returns 1 for success, 0 for failure.
int S3_UploadFile(string localFilePath, string contentType, string bucketPath, string objectName)
Uploads a file to the Amazon S3 service. Returns 1 for success, 0 for failure. S3 Upload File
bool S3_UploadString(string objectContent, string charset, string contentType, string bucketPath, string objectName)
Uploads an in-memory string to the Amazon S3 service. This is the same as UploadFile, except that the file contents are from an in-memory string instead of a local file. Internal to this method, the objectContent is converted to the character encoding specified by charset prior to uploading. Returns 1 for success, 0 for failure. S3 Upload String
bool SaveLastError(string filename)
Saves the last error information to an XML formatted file.
bool SetCookieXml(string domain, string cookieXml)
Restores cookies for a particular domain. It is assumed that the cookie XML was previously retrieved via the GetCookieXml method, and saved to some sort of persistent storage, such as within a database table. It is then possible for an application to restore the cookies by calling this method. Returns 1 for success, 0 for failure.
void SetRequestHeader(string name, string value)
Adds or replaces a custom HTTP request header to be sent with all GET requests issued by the QuickGet and QuickGetStr methods.
void SetSslClientCert(Chilkat.Cert iCert)
Allows for a client-side certificate to be used for an SSL connection.
int SetSslClientCertPem(string pemDataOrFilename, string pemPassword)
To be documented soon...
bool SetSslClientCertPfx(string pfxFilename, string pfxPassword, string certSubjectCN)
To be documented soon...
void SleepMs(int millisec)
To be documented soon...
Chilkat.HttpResponse SynchronousRequest(string domain, int port, int ssl, Chilkat.HttpRequest req)
Sends an explicit HttpRequest to an HTTP server and returns an HttpResponse object. The HttpResponse object provides full access to the response including all headers and the response body. This method may be used to send POST requests, as well as GET, HEAD, file uploads, and XMLHTTP. Simple HTTP POST Debugging HTTP Send XMLHttpRequest using PUT, GET, DELETE, or any HTTP Request Method Adding Cookies to an HTTP Request
bool UnlockComponent(string unlockCode)
Unlocks the Http class/component. It is necessary to call Http.UnlockComponent before calling any other methods. Passing any string to UnlockComponent will automatically activate a 30-day trial period. Returns 1 for success, 0 for failure.
string UrlDecode(string str)
URL decodes a string. Returns a null on failure
string UrlEncode(string str)
URL encodes a string. Returns a null on failure
string XmlRpc(string urlEndpoint, string xmlIn)
Makes an XML RPC call to a URL endpoint. The XML string is passed in an HTTP POST, and the XML response is returned. Returns a null on failure
string XmlRpcPut(string urlEndpoint, string xmlIn)
Same as XmlRpc, but uses the HTTP PUT method instead of the POST method. Returns a null on failure
|