HttpResponse Tcl Reference Documentation
HttpResponse
Current Version: 11.5.0
Chilkat.HttpResponse
Read the HTTP status code, status line, and related response information
to determine whether the request succeeded, redirected, or failed.
Inspect response headers, retrieve individual header values, and access
cookies returned by the server.
Get the response body as raw bytes or decoded text, using the response
charset information when appropriate.
Load the body directly into
Access redirect-related information such as the redirect URL when the
server responds with a redirect status.
Save body content, inspect the full MIME-style response, and use response
metadata for diagnostics, logging, or API troubleshooting.
For an extended overview, see
HttpResponse Class Overview.
Inspect HTTP status, headers, cookies, redirects, and response bodies.
Chilkat.HttpResponse represents an HTTP response returned by
certain Chilkat.Http methods. It provides access to the response
status line, status code, headers, cookies, charset, content length, body
bytes, body text, full MIME response, redirect URL, and helper methods for
saving or loading the response body into Chilkat objects such as
BinData, StringBuilder, JsonObject,
JsonArray, and Xml.
Status and reason
Headers and cookies
Body as text or bytes
Structured body loading
JsonObject,
JsonArray, Xml, BinData, or
StringBuilder objects for further processing.
Redirect information
Save and inspect responses
Chilkat.Http, check the
StatusCode, inspect headers or cookies as needed, then retrieve
the body in the form best suited to the response content: text, bytes,
BinData, StringBuilder, JSON, or XML. Use
HttpResponse for response inspection; use Chilkat.Http
for the actual network request.
Object Creation
# 'this' is not a keyword in Tcl. It can freely be used as a variable name. set this [new CkHttpResponse]
Properties
BodyQP
# ckStr is a CkString
CkHttpResponse_get_BodyQP $this $ckStr
set strVal [CkHttpResponse_get_bodyQP $this]
The same as the Body property, but returned as a quoted-printable encoded string.
topBodyStr
# ckStr is a CkString
CkHttpResponse_get_BodyStr $this $ckStr
set strVal [CkHttpResponse_get_bodyStr $this]
The response body returned as a string.
topCharset
# ckStr is a CkString
CkHttpResponse_get_Charset $this $ckStr
set strVal [CkHttpResponse_get_charset $this]
The response charset, such as iso-8859-1, if applicable. Obviously, responses for GIF and JPG files will not have a charset.
ContentLength
set intVal [CkHttpResponse_get_ContentLength $this]
The content length of the response, in bytes.
topContentLength64
set int64Val [CkHttpResponse_get_ContentLength64 $this]
The content length of the response, in number of bytes, returned as a 64-bit integer.
topDateStr
# ckStr is a CkString
CkHttpResponse_get_DateStr $this $ckStr
set strVal [CkHttpResponse_get_dateStr $this]
Returns the content of the Date response header field in RFC822 date/time string format.
topDebugLogFilePath
# ckStr is a CkString
CkHttpResponse_get_DebugLogFilePath $this $ckStr
set strVal [CkHttpResponse_get_debugLogFilePath $this]
CkHttpResponse_put_DebugLogFilePath $this $strVal
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Domain
# ckStr is a CkString
CkHttpResponse_get_Domain $this $ckStr
set strVal [CkHttpResponse_get_domain $this]
The domain of the HTTP server that created this response.
topFinalRedirectUrl
# ckStr is a CkString
CkHttpResponse_get_FinalRedirectUrl $this $ckStr
set strVal [CkHttpResponse_get_finalRedirectUrl $this]
Returns the redirect URL for 301/302 responses.
topFullMime
# ckStr is a CkString
CkHttpResponse_get_FullMime $this $ckStr
set strVal [CkHttpResponse_get_fullMime $this]
Header
# ckStr is a CkString
CkHttpResponse_get_Header $this $ckStr
set strVal [CkHttpResponse_get_header $this]
The full text of the response header.
topLastErrorHtml
# ckStr is a CkString
CkHttpResponse_get_LastErrorHtml $this $ckStr
set strVal [CkHttpResponse_get_lastErrorHtml $this]
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
# ckStr is a CkString
CkHttpResponse_get_LastErrorText $this $ckStr
set strVal [CkHttpResponse_get_lastErrorText $this]
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
# ckStr is a CkString
CkHttpResponse_get_LastErrorXml $this $ckStr
set strVal [CkHttpResponse_get_lastErrorXml $this]
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
set boolVal [CkHttpResponse_get_LastMethodSuccess $this]
CkHttpResponse_put_LastMethodSuccess $this $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
NumCookies
set intVal [CkHttpResponse_get_NumCookies $this]
The number of cookies included in the response.
topNumHeaderFields
set intVal [CkHttpResponse_get_NumHeaderFields $this]
The number of response header fields.
topStatusCode
set intVal [CkHttpResponse_get_StatusCode $this]
The status code (as an integer) from the first line of an HTTP response. If the StatusLine = HTTP/1.0 200 OK, the response status code returned is 200.
StatusLine
# ckStr is a CkString
CkHttpResponse_get_StatusLine $this $ckStr
set strVal [CkHttpResponse_get_statusLine $this]
The first line of an HTTP response, such as HTTP/1.0 200 OK.
StatusText
# ckStr is a CkString
CkHttpResponse_get_StatusText $this $ckStr
set strVal [CkHttpResponse_get_statusText $this]
The text that follows the status code in the 1st line of the HTTP response. For example, i the first line of an HTTP response is HTTP/1.0 200 OK, then this property contains OK.
UncommonOptions
# ckStr is a CkString
CkHttpResponse_get_UncommonOptions $this $ckStr
set strVal [CkHttpResponse_get_uncommonOptions $this]
CkHttpResponse_put_UncommonOptions $this $strVal
This is a catch-all property to be used for uncommon needs. Can be set to a list of the following comma separated keywords:
TakeResponseBody- Introduced in v9.5.0.89. The GetBody* methods will transfer the body to the target object instead of copying the contents. This can be useful if the response body is extremely large because it will reduce the overall memory requirement.
Utf8
set boolVal [CkHttpResponse_get_Utf8 $this]
CkHttpResponse_put_Utf8 $this $boolVal
When set to 1, all string arguments and return values are interpreted as UTF-8 strings. When set to 0, they are interpreted as ANSI strings.
In Chilkat v11.0.0 and later, the default value is 1. Before v11.0.0, it was 0.
VerboseLogging
set boolVal [CkHttpResponse_get_VerboseLogging $this]
CkHttpResponse_put_VerboseLogging $this $boolVal
If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
# ckStr is a CkString
CkHttpResponse_get_Version $this $ckStr
set strVal [CkHttpResponse_get_version $this]
Methods
GetBodyBd
set status [CkHttpResponse_GetBodyBd $this $binData]
Copies the response body to a BinData object.
Returns 1 for success, 0 for failure.
GetBodyJarr
set status [CkHttpResponse_GetBodyJarr $this $jarr]
Loads the JSON array response body into a JsonArray This method should only be called when it is known that the response body contains a JSON array (beginning with a square bracket '[' and ending with a square bracket ']')
Returns 1 for success, 0 for failure.
GetBodyJson
set status [CkHttpResponse_GetBodyJson $this $json]
Loads the JSON response body into a JsonObject. This method should only be called when it is known that the response body contains JSON (beginning with a curly brace '{' and ending with a curly brace '}')
Returns 1 for success, 0 for failure.
GetBodySb
set status [CkHttpResponse_GetBodySb $this $sb]
Copies the response body to a Chilkat StringBuilder object.
Returns 1 for success, 0 for failure.
topGetBodyXml
set status [CkHttpResponse_GetBodyXml $this $xml]
Loads the XML response body into an XML object. This method should only be called when it is known that the response body contains XML.
Returns 1 for success, 0 for failure.
GetCookieDomain
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieDomain $this $index $outStr]
set retStr [CkHttpResponse_getCookieDomain $this $index]
Returns the domain of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieExpiresStr
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieExpiresStr $this $index $outStr]
set retStr [CkHttpResponse_getCookieExpiresStr $this $index]
Returns the expiration date/time of the Nth cookie in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieName
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieName $this $index $outStr]
set retStr [CkHttpResponse_getCookieName $this $index]
Returns the name of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookiePath
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookiePath $this $index $outStr]
set retStr [CkHttpResponse_getCookiePath $this $index]
Returns the path of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetCookieValue
# outStr is a CkString (output)
set status [CkHttpResponse_GetCookieValue $this $index $outStr]
set retStr [CkHttpResponse_getCookieValue $this $index]
Returns the value of the Nth cookie returned in the response. Indexing begins at 0. The number of response cookies is specified in the NumCookies property.
Returns 1 for success, 0 for failure.
topGetHeaderField
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderField $this $fieldName $outStr]
set retStr [CkHttpResponse_getHeaderField $this $fieldName]
Returns the value of a response header field accessed by field name.
Returns 1 for success, 0 for failure.
topGetHeaderFieldAttr
# attrName is a string
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderFieldAttr $this $fieldName $attrName $outStr]
set retStr [CkHttpResponse_getHeaderFieldAttr $this $fieldName $attrName]
Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr(content-type,charset)
Returns 1 for success, 0 for failure.
topGetHeaderName
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderName $this $index $outStr]
set retStr [CkHttpResponse_getHeaderName $this $index]
Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Returns 1 for success, 0 for failure.
topGetHeaderValue
# outStr is a CkString (output)
set status [CkHttpResponse_GetHeaderValue $this $index $outStr]
set retStr [CkHttpResponse_getHeaderValue $this $index]
Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Returns 1 for success, 0 for failure.
topLoadTaskResult
set status [CkHttpResponse_LoadTaskResult $this $task]
Loads the HTTP response from a completed asynchronous task. A failed return value indicates that no HTTP response was received in the HTTP asynchronous method call (i.e. the asynchronous HTTP request failed in such a way that no response was received).
Returns 1 for success, 0 for failure.
SaveBodyBinary
set status [CkHttpResponse_SaveBodyBinary $this $path]
Saves the body of the HTTP response to a file.
Returns 1 for success, 0 for failure.
SaveBodyText
# path is a string
set status [CkHttpResponse_SaveBodyText $this $bCrlf $path]
Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is 1, then line endings are automatically converted to CRLF if necessary. If bCrlf is 0, then line-endings are automatically converted to bare-LF's (Unix style) if necessary.
To save the HTTP response body exactly as-is (with no line-ending manipulation), then call SaveBodyBinary.
Returns 1 for success, 0 for failure.
topUrlEncParamValue
# paramName is a string
# outStr is a CkString (output)
set status [CkHttpResponse_UrlEncParamValue $this $encodedParamString $paramName $outStr]
set retStr [CkHttpResponse_urlEncParamValue $this $encodedParamString $paramName]
Convenience method for parsing a param's value out of a URL-encoded param string. For example, if a caller passes the following string in encodedParamString:
oauth_token=ABC&oauth_token_secret=123&oauth_callback_confirmed=trueand
oauth_token_secret in paramName, then the return value would be 123.Returns 1 for success, 0 for failure.
top