HttpRequest Dart Reference Documentation
CkHttpRequest
Current Version: 11.6.1
Chilkat.HttpRequest
Build an HTTP request object with the method, path, version, headers,
parameters, and body settings required by the target endpoint.
Add name/value parameters for form posts and API requests that expect
structured form data.
Set request headers such as content type, accept headers, authorization
headers, or application-specific metadata.
Provide body content for POST, PUT, PATCH, or other methods that send
data to a server.
Construct multipart/form-data requests, attach file parts, or stream a
file as the request body when the API requires upload content.
Generate a textual representation of the request to inspect headers,
paths, parameters, body structure, and upload formatting before sending.
For an extended overview, see
HttpRequest Class Overview.
Build structured HTTP requests for use with Chilkat.Http.
Chilkat.HttpRequest is a helper class for constructing HTTP
requests that are sent by Chilkat.Http. It does not perform
network communication on its own. Instead, it provides structured control
over the request method, HTTP version, path, headers, query parameters,
form parameters, content type, request body, multipart uploads, streamed
file bodies, and diagnostic request generation.
Request construction
Form parameters
Custom headers
Request bodies
Multipart and file uploads
Diagnostics
HttpRequest, set the HTTP method and path, add any
headers, parameters, body data, or file parts, then pass the request object
to the appropriate Chilkat.Http method for sending. Use
HttpRequest for structured or multipart requests; use simpler
Http methods directly when only a basic GET, POST, upload, or
download is needed.
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 httpRequest = CkHttpRequest();
// ... the native object is released when `httpRequest` is garbage collected, or now with httpRequest.dispose().Creates the underlying native Chilkat object. Use a CkHttpRequest 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 {
httpRequest.someMethod(...);
} on ChilkatException catch (e) {
print(e); // CkHttpRequest.someMethod failed: <reason>
print(e.lastErrorText); // the full Chilkat log of the failed call
}Properties
Boundary
String get boundary
set boundary(String value)
Sets an explicit boundary string to be used in multipart/form-data requests. If no Boundary is set, then a boundary string is automaticaly generated as needed during the sending of a request.
Charset
String get charset
set charset(String value)
Controls the character encoding used in the URL encoding of query params. The default value of this propoerty is utf-8.
ContentType
String get contentType
set contentType(String value)
The ContentType property sets the Content-Type header field, and identifies the content-type of the HTTP request body. Common values are:
If ContentType is set equal to the empty string, then no Content-Type header is included in the HTTP request.application/x-www-form-urlencoded multipart/form-data application/json application/xml
DebugLogFilePath
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.
EntireHeader
String get entireHeader
set entireHeader(String value)
Composes and returns the entire MIME header of the HTTP request.
topHttpVerb
String get httpVerb
set httpVerb(String value)
The HttpVerb property should be set to the name of the HTTP method that appears on the start line of an HTTP request, such as GET, POST, PUT, DELETE, etc. It is also possible to use the various WebDav verbs such as PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK, UNLOCK, etc. In general, the HttpVerb may be set to anything, even custom verbs recognized by a custom server-side app.
HttpVersion
String get httpVersion
set httpVersion(String value)
The HTTP version in the request header. Defaults to 1.1. Can only be set to 1.0 or 1.1.
LastErrorHtml
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.
NumHeaderFields
int get numHeaderFields
Returns the number of request header fields.
topNumParams
int get numParams
Path
String get path
set path(String value)
The path of the resource requested. A path of / indicates the default document of a domain.
Explaining the Parts of a URL
http://example.com:8042/over/there?name=ferret#nose \__/ \______________/\_________/ \________/ \__/ | | | | | scheme domain+port path query fragment
This property should be set to the path part of the URL. You may also include the query part in this property value. If the Content-Type of the request is NOT application/x-www-form-urlencoded, then you would definitely want to include query parameters in the path. If the Content-Type of the request IS application/x-www-form-urlencoded, the query parameters are passed in the body of the request. It is also possible to pass some query parameters via the path, and some in the body of a application/x-www-form-urlencoded request, but you shouldn't include the same parameter in both places. You would never need to include the fragment part. The fragment is nothing more than an instruction for a browser to automatically navigate to a particular location in the HTML page (assuming the request returns HTML, otherwise a fragment makes no sense).
SendCharset
bool get sendCharset
set sendCharset(bool value)
Controls whether the charset is explicitly included in the content-type header field of the HTTP POST request. The default value of this property is false.
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
AddBdForUpload
Adds a file to an upload request where the contents of the file come from byteData.
name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
remoteFilename is the name of the file to be created on the HTTP server.
byteData contains the bytes to be uploaded.
contentType contains is the value of the Content-Type header. An empty string may be passed to allow Chilkat to automatically determine the Content-Type based on the filename extension.
Returns normally on success; throws a ChilkatException on failure.
AddFileForUpload
Adds a file to an upload request. To create a file upload request, set the ContentType property = multipart/form-data and then call AddFileForUpload, AddBytesForUpload, or AddStringForUpload for each file to be uploaded. This method does not read the file into memory. When the upload occurs, the data is streamed directly from the file, thus allowing for very large files to be uploaded without consuming large amounts of memory.
name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.
Returns normally on success; throws a ChilkatException on failure.
AddFileForUpload2
Same as AddFileForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the file extension.)
name is an arbitrary name. (In HTML, it is the form field name of the input tag.)
filePath is the path to an existing file in the local filesystem.
Returns normally on success; throws a ChilkatException on failure.
AddHeader
Adds a request header to the HTTP request. If a header having the same field name is already present, this method replaces it.
Note: Never explicitly set the Content-Length header field. Chilkat will automatically compute the correct length and add the Content-Length header to all POST, PUT, or any other request where the Content-Length needs to be specified. (GET requests always have a 0 length body, and therefore never need a Content-Length header field.)
AddMwsSignature
Computes the Amazon MWS signature using the mwsSecretKey and adds the Signature parameter to the request. This method should be called for all Amazon Marketplace Web Service (Amazon MWS) HTTP requests. It should be called after all request parameters have been added.
Important: The Chilkat v9.5.0.75 release accidentally breaks Amazon MWS (not AWS) authentication. If you need MWS with 9.5.0.75, send email to support@chilkatsoft.com for a hotfix, or revert back to v9.5.0.73, or update to a version after 9.5.0.75.
The domain should be the domain of the request, such as one of the following:
- mws.amazonservices.com
- mws-eu.amazonservices.com
- mws.amazonservices.in
- mws.amazonservices.com.cn
- mws.amazonservices.jp
Note: This method automatically adds or replaces the existing Timestamp parameter to the current system date/time.
Returns normally on success; throws a ChilkatException on failure.
AddParam
Adds a request query parameter (name/value pair) to the HTTP request. The name and value strings passed to this method should not be URL encoded.
AddStringForUpload
Same as AddFileForUpload, but the upload data comes from an in-memory string instead of a file.
Returns normally on success; throws a ChilkatException on failure.
AddStringForUpload2
Same as AddStringForUpload, but allows the Content-Type header field to be directly specified. (Otherwise, the Content-Type header is automatically determined based on the filename's file extension.)
Returns normally on success; throws a ChilkatException on failure.
AddSubHeader
Adds a request header to the Nth sub-header of the HTTP request. If a header having the same field name is already present, this method replaces it.
Returns normally on success; throws a ChilkatException on failure.
GenerateRequestFile
The same as GenerateRequestText, except the generated request is written to the file specified by path.
Returns normally on success; throws a ChilkatException on failure.
GenerateRequestText
Returns the request text that would be sent if Http.SynchronousRequest was called.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderField
Returns the value of a request header field.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderName
Returns the Nth request header field name. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetHeaderValue
Returns the Nth request header field value. Indexing begins at 0, and the number of request header fields is specified by the NumHeaderFields property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetParam
Returns a request query parameter value by name.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetParamName
Returns the Nth request query parameter field name. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetParamValue
Returns the Nth request query parameter field value. Indexing begins at 0, and the number of request query parameter fields is specified by the NumParams property.
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
GetUrlEncodedParams
Returns the request parameters in URL encoded form (i.e. in the exact form that would be sent if the ContentType property was application/x-www-form-urlencoded). For example, if a request has two params: param1=abc 123 and param2=abc-123, then GetUrlEncodedParams would return abc+123¶m2=abc%2D123
Throws a ChilkatException on failure (where the description says null is returned, the Dart method throws instead).
LoadBodyFromBd
Uses the contents of the requestBody as the HTTP request body.
Returns normally on success; throws a ChilkatException on failure.
LoadBodyFromFile
The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of filePath.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.
Returns normally on success; throws a ChilkatException on failure.
LoadBodyFromSb
Uses the contents of the requestBody as the HTTP request body. The charset indicates the binary representation of the string, such as utf-8, utf-16, iso-8859-*, windows-125*, etc. Any of the character encodings supported at the link below are valid.
Returns normally on success; throws a ChilkatException on failure.
LoadBodyFromString
The HTTP protocol is such that all HTTP requests are MIME. For non-multipart requests, this method may be called to set the MIME body of the HTTP request to the exact contents of bodyStr.
Note: A non-multipart HTTP request consists of (1) the HTTP start line, (2) MIME header fields, and (3) the MIME body. This method sets the MIME body.
charset indicates the charset, such as utf-8 or iso-8859-1, to be used. The HTTP body will contain the bodyStr converted to this character encoding.
Returns normally on success; throws a ChilkatException on failure.
RemoveAllParams
RemoveHeader
Removes all occurrences of a HTTP request header field. Always returns true.
Returns normally on success; throws a ChilkatException on failure.
RemoveParam
SetFromUrl
Parses a URL and sets the Path and query parameters (NumParams, GetParam, GetParamName, GetParamValue).
StreamBodyFromFile
Useful for sending HTTP requests where the body is a very large file. For example, to send an XML HttpRequest containing a very large XML document, one would set the HttpVerb = POST, the ContentType = text/xml, and then call StreamBodyFromFile to indicate that the XML body of the request is to be streamed directly from a file. When the HTTP request is actually sent, the body is streamed directly from the file, and thus the file never needs to be loaded in its entirety in memory.
Returns normally on success; throws a ChilkatException on failure.
StreamChunkFromFile
This method is the same as StreamBodyFromFile, but allows for an offset and number of bytes to be specified. The offset and numBytes are integers passed as strings.
Returns normally on success; throws a ChilkatException on failure.