CkHttpResponse Ruby Reference Documentation

CkHttpResponse

Current Version: 9.5.0.73

Represents a complete HTTP response.

Object Creation

obj = Chilkat::CkHttpResponse.new()

Properties

Body
# ckBytes is a CkByteData
httpResponse.get_Body(ckBytes);

The response body returned as a byte array.

top
BodyQP
# strVal is a string
# ckStr is a CkString
httpResponse.get_BodyQP(ckStr);
strVal = httpResponse.bodyQP();

The same as the Body property, but returned as a quoted-printable encoded string.

top
BodyStr
# strVal is a string
# ckStr is a CkString
httpResponse.get_BodyStr(ckStr);
strVal = httpResponse.bodyStr();

The response body returned as a string.

top
Charset
# strVal is a string
# ckStr is a CkString
httpResponse.get_Charset(ckStr);
strVal = httpResponse.charset();

The response charset, such as "iso-8859-1", if applicable. Obviously, responses for GIF and JPG files will not have a charset.

top
ContentLength
# intVal is a unsigned long
intVal = httpResponse.get_ContentLength();

The content length of the response, in bytes.

top
ContentLength64
# int64Val is a 64-bit integer
int64Val = httpResponse.get_ContentLength64();

The content length of the response, in number of bytes, returned as a 64-bit integer.

top
DateStr
# strVal is a string
# ckStr is a CkString
httpResponse.get_DateStr(ckStr);
strVal = httpResponse.dateStr();

Returns the content of the Date response header field in RFC822 date/time string format.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
httpResponse.get_DebugLogFilePath(ckStr);
strVal = httpResponse.debugLogFilePath();
httpResponse.put_DebugLogFilePath(strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang 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.

top
Domain
# strVal is a string
# ckStr is a CkString
httpResponse.get_Domain(ckStr);
strVal = httpResponse.domain();

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
# strVal is a string
# ckStr is a CkString
httpResponse.get_FinalRedirectUrl(ckStr);
strVal = httpResponse.finalRedirectUrl();
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
# strVal is a string
# ckStr is a CkString
httpResponse.get_FullMime(ckStr);
strVal = httpResponse.fullMime();

Returns the full MIME (header + body) of the HTTP response.

top
Header
# strVal is a string
# ckStr is a CkString
httpResponse.get_Header(ckStr);
strVal = httpResponse.header();

The full text of the response header.

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
httpResponse.get_LastErrorHtml(ckStr);
strVal = httpResponse.lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
# strVal is a string
# ckStr is a CkString
httpResponse.get_LastErrorText(ckStr);
strVal = httpResponse.lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
# strVal is a string
# ckStr is a CkString
httpResponse.get_LastErrorXml(ckStr);
strVal = httpResponse.lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
# boolVal is a boolean
boolVal = httpResponse.get_LastMethodSuccess();
httpResponse.put_LastMethodSuccess(boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumCookies
# intVal is an integer
intVal = httpResponse.get_NumCookies();

The number of cookies included in the response.

top
NumHeaderFields
# intVal is an integer
intVal = httpResponse.get_NumHeaderFields();

The number of response header fields.

top
StatusCode
# intVal is an integer
intVal = httpResponse.get_StatusCode();

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.

top
StatusLine
# strVal is a string
# ckStr is a CkString
httpResponse.get_StatusLine(ckStr);
strVal = httpResponse.statusLine();

The first line of an HTTP response, such as "HTTP/1.0 200 OK".

top
StatusText
# strVal is a string
# ckStr is a CkString
httpResponse.get_StatusText(ckStr);
strVal = httpResponse.statusText();
Introduced in version 9.5.0.49

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".

top
Utf8
# boolVal is a boolean
boolVal = httpResponse.get_Utf8();
httpResponse.put_Utf8(boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
# boolVal is a boolean
boolVal = httpResponse.get_VerboseLogging();
httpResponse.put_VerboseLogging(boolVal);

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
# strVal is a string
# ckStr is a CkString
httpResponse.get_Version(ckStr);
strVal = httpResponse.version();

Version of the component/library, such as "9.5.0.63"

top

Methods

GetBodyBd
# binData is a CkBinData
status = httpResponse.GetBodyBd(binData);
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

top
GetBodySb
# sb is a CkStringBuilder
status = httpResponse.GetBodySb(sb);
Introduced in version 9.5.0.64

Copies the response body to a Chilkat StringBuilder object.

Returns true for success, false for failure.

top
GetCookieDomain
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetCookieDomain(index, outStr);
retStr = httpResponse.getCookieDomain(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 true for success, false for failure.

top
GetCookieExpiresStr
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetCookieExpiresStr(index, outStr);
retStr = httpResponse.getCookieExpiresStr(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 true for success, false for failure.

top
GetCookieName
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetCookieName(index, outStr);
retStr = httpResponse.getCookieName(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 true for success, false for failure.

top
GetCookiePath
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetCookiePath(index, outStr);
retStr = httpResponse.getCookiePath(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 true for success, false for failure.

top
GetCookieValue
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetCookieValue(index, outStr);
retStr = httpResponse.getCookieValue(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 true for success, false for failure.

top
GetHeaderField
# fieldName is a string
# outStr is a CkString (output)
status = httpResponse.GetHeaderField(fieldName, outStr);
retStr = httpResponse.getHeaderField(fieldName);

Returns the value of a response header field accessed by field name.

Returns true for success, false for failure.

top
GetHeaderFieldAttr
# fieldName is a string
# attrName is a string
# outStr is a CkString (output)
status = httpResponse.GetHeaderFieldAttr(fieldName, attrName, outStr);
retStr = httpResponse.getHeaderFieldAttr(fieldName, attrName);

Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr("content-type","charset")

Returns true for success, false for failure.

top
GetHeaderName
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetHeaderName(index, outStr);
retStr = httpResponse.getHeaderName(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 true for success, false for failure.

top
GetHeaderValue
# index is an integer
# outStr is a CkString (output)
status = httpResponse.GetHeaderValue(index, outStr);
retStr = httpResponse.getHeaderValue(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 true for success, false for failure.

top
LoadTaskResult
# task is a CkTask
status = httpResponse.LoadTaskResult(task);
Introduced in version 9.5.0.52

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 true for success, false for failure.

top
SaveBodyBinary
# path is a string
status = httpResponse.SaveBodyBinary(path);

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

top
SaveBodyText
# bCrlf is a boolean
# path is a string
status = httpResponse.SaveBodyText(bCrlf, path);

Saves the HTTP response body to a file. This method provides control over CRLF vs bare-LF line-endings. If bCrlf is true, then line endings are automatically converted to CRLF if necessary. If bCrlf is false, 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 true for success, false for failure.

top
SaveLastError
# path is a string
status = httpResponse.SaveLastError(path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top
UrlEncParamValue
# encodedParamString is a string
# paramName is a string
# outStr is a CkString (output)
status = httpResponse.UrlEncParamValue(encodedParamString, paramName, outStr);
retStr = httpResponse.urlEncParamValue(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=true
and "oauth_token_secret" in paramName, then the return value would be "123".

Returns true for success, false for failure.

top