HttpResponse Dart Reference Documentation
CkHttpResponse
Current Version: 11.6.1
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
// pubspec.yaml:
// dependencies:
// chilkat: ^11.6.1
import 'package:chilkat/chilkat.dart';
// Once per process, before any other Chilkat call:
Chilkat.unlockBundle('Anything for 30-day trial'); // shorthand for CkGlobal().unlockBundle(..)
final httpResponse = CkHttpResponse();
// ... the native object is released when `httpResponse` is garbage collected, or now with httpResponse.dispose().Creates the underlying native Chilkat object. Use a CkHttpResponse only from the isolate that created it: Chilkat objects cannot be sent between isolates. Every call is synchronous; in a Flutter app, run long operations (network, large files) inside Isolate.run, creating the Chilkat objects inside the isolate.
Releases the native object immediately instead of waiting for garbage collection (useful for a large CkBinData or an open socket). Calling it more than once is harmless; any other use of the object afterwards throws a StateError. isDisposed tells whether it has been called.
Errors
A method that can fail throws a ChilkatException: a method whose only outcome is success or failure returns void and throws on failure; a method producing a String or an object returns it and throws where Chilkat would have returned null. The exception carries the object's LastErrorText at the time of the failure (lastErrorText), the class and method names (className, methodName) and a one-line message. Properties never throw, and methods that answer a question (has..., is..., ...) return a plain bool.
try {
httpResponse.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkHttpResponse.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
BodyQP
String get bodyQP
The same as the Body property, but returned as a quoted-printable encoded string.
topBodyStr
String get bodyStr
The response body returned as a string.
topCharset
String get charset
The response charset, such as iso-8859-1, if applicable. Obviously, responses for GIF and JPG files will not have a charset.
ContentLength
int get contentLength
The content length of the response, in bytes.
topContentLength64
int get contentLength64
The content length of the response, in number of bytes, returned as a 64-bit integer.
topDateStr
String get dateStr
Returns the content of the Date response header field in RFC822 date/time string format.
topDebugLogFilePath
String get debugLogFilePath
set debugLogFilePath(String value)
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
String get domain
The domain of the HTTP server that created this response.
topFinalRedirectUrl
String get finalRedirectUrl
Returns the redirect URL for 301/302 responses.
topFullMime
String get fullMime
Header
String get header
The full text of the response header.
topLastErrorHtml
String get lastErrorHtml
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
String get lastErrorText
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
String get lastErrorXml
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
bool get lastMethodSuccess
set lastMethodSuccess(bool value)
Indicates the success or failure of the most recent method call: true means success, false 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
int get numCookies
The number of cookies included in the response.
topNumHeaderFields
int get numHeaderFields
The number of response header fields.
topStatusCode
int 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.
StatusLine
String get statusLine
The first line of an HTTP response, such as HTTP/1.0 200 OK.
StatusText
String get statusText
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
String get uncommonOptions
set uncommonOptions(String value)
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.
VerboseLogging
bool get verboseLogging
set verboseLogging(bool value)
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.
Version
String get version
Methods
GetBodyBd
Copies the response body to a BinData object.
Returns normally on success; throws a ChilkatException on failure.
GetBodyJarr
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 normally on success; throws a ChilkatException on failure.
GetBodyJson
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 normally on success; throws a ChilkatException on failure.
GetBodySb
Copies the response body to a Chilkat StringBuilder object.
Returns normally on success; throws a ChilkatException on failure.
GetBodyXml
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 normally on success; throws a ChilkatException on failure.
GetCookieDomain
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.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetCookieExpiresStr
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.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetCookieName
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.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetCookiePath
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.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetCookieValue
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.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderField
Returns the value of a response header field accessed by field name.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderFieldAttr
Returns a response header field attribute. As an example, the response charset is simply the GetHeaderFieldAttr(content-type,charset)
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderName
Gets the name of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderValue
Gets the value of the Nth response header field. Indexing begins at 0. The number of response headers is specified by the NumHeaderFields property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
SaveBodyBinary
Saves the body of the HTTP response to a file.
Returns normally on success; throws a ChilkatException on failure.
SaveBodyText
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 normally on success; throws a ChilkatException on failure.
UrlEncParamValue
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.Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).