CkoHttpResponse Swift Reference Documentation

CkoHttpResponse

Current Version: 9.5.0.73

Represents a complete HTTP response.

Object Creation

let obj = CkoHttpResponse()

Properties

Body
Body: NSData (read-only)

The response body returned as a byte array.

top
BodyQP
BodyQP: String (read-only)

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

top
BodyStr
BodyStr: String (read-only)

The response body returned as a string.

top
Charset
Charset: String (read-only)

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

top
ContentLength
ContentLength: UInt (read-only)

The content length of the response, in bytes.

top
ContentLength64
ContentLength64: Int64 (read-only)

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

top
Date
Date: NSDate (read-only)
This property is deprecated. It will be removed in a future version.

The Date response header field, returned in a date/time data type.

top
DateStr
DateStr: String (read-only)

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

top
DebugLogFilePath
DebugLogFilePath: String

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
Domain: String (read-only)

The domain of the HTTP server that created this response.

top
FinalRedirectUrl
FinalRedirectUrl: String (read-only)
Introduced in version 9.5.0.49

Returns the redirect URL for 301/302 responses.

top
FullMime
FullMime: String (read-only)

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

top
Header
Header: String (read-only)

The full text of the response header.

top
LastErrorHtml
LastErrorHtml: String (read-only)

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
LastErrorText: String (read-only)

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
LastErrorXml: String (read-only)

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
LastMethodSuccess: Bool
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
NumCookies: Int (read-only)

The number of cookies included in the response.

top
NumHeaderFields
NumHeaderFields: Int (read-only)

The number of response header fields.

top
StatusCode
StatusCode: Int (read-only)

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
StatusLine: String (read-only)

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

top
StatusText
StatusText: String (read-only)
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
VerboseLogging
VerboseLogging: Bool

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
Version: String (read-only)

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

top

Methods

GetBodyBd
GetBodyBd(binData: CkoBinData) -> Bool
Introduced in version 9.5.0.64

Copies the response body to a BinData object.

Returns true for success, false for failure.

top
GetBodySb
GetBodySb(sb: CkoStringBuilder) -> Bool
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
GetCookieDomain(index: Int) -> String

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 nil on failure

top
GetCookieExpires
GetCookieExpires(index: Int) -> NSDate
This method is deprecated. It will be removed in a future version.

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.

top
GetCookieExpiresStr
GetCookieExpiresStr(index: Int) -> String

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 nil on failure

top
GetCookieName
GetCookieName(index: Int) -> String

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 nil on failure

top
GetCookiePath
GetCookiePath(index: Int) -> String

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 nil on failure

top
GetCookieValue
GetCookieValue(index: Int) -> String

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 nil on failure

top
GetHeaderField
GetHeaderField(fieldName: String) -> String

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

Returns nil on failure

top
GetHeaderFieldAttr
GetHeaderFieldAttr(fieldName: String, attrName: String) -> String

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

Returns nil on failure

top
GetHeaderName
GetHeaderName(index: Int) -> String

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 nil on failure

top
GetHeaderValue
GetHeaderValue(index: Int) -> String

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 nil on failure

top
LoadTaskResult
LoadTaskResult(task: CkoTask) -> Bool
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
SaveBodyBinary(path: String) -> Bool

Saves the body of the HTTP response to a file.

Returns true for success, false for failure.

top
SaveBodyText
SaveBodyText(bCrlf: Bool, path: String) -> Bool

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
SaveLastError(path: String) -> Bool

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

Returns true for success, false for failure.

top
UrlEncParamValue
UrlEncParamValue(encodedParamString: String, paramName: String) -> String

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 nil on failure

top