dart:io

HttpClientRequest class

HTTP request for a client connection.

To set up a request, set the headers using the headers property provided in this class and write the data to the body of the request. HttpClientRequest is an IOSink. Use the methods from IOSink, such as writeCharCode(), to write the body of the HTTP request. When one of the IOSink methods is used for the first time, the request header is sent. Calling any methods that change the header after it is sent throws an exception.

When writing string data through the IOSink the encoding used is determined from the "charset" parameter of the "Content-Type" header.

var client = HttpClient();
HttpClientRequest request = await client.get('localhost', 80, '/file.txt');
request.headers.contentType =
    ContentType('application', 'json', charset: 'utf-8');
request.write('text content👍🎯'); // Strings written will be UTF-8 encoded.

If no charset is provided the default of ISO-8859-1 (Latin 1) is used.

var client = HttpClient();
HttpClientRequest request = await client.get('localhost', 80, '/file.txt');
request.headers.add(HttpHeaders.contentTypeHeader, "text/plain");
request.write('blåbærgrød'); // Strings written will be ISO-8859-1 encoded

An exception is thrown if you use an unsupported encoding and the write() method being used takes a string parameter.

Implemented types

• IOSink

Constructors

HttpClientRequest()

Properties

bufferOutput ↔ bool

read / write

Gets or sets if the HttpClientRequest should buffer output.

connectionInfo → HttpConnectionInfo?

read-only

Gets information about the client connection.

contentLength ↔ int

read / write

Gets and sets the content length of the request.

cookies → List<Cookie>

read-only

Cookies to present to the server (in the 'cookie' header).

done → Future<HttpClientResponse>

read-only, override

A HttpClientResponse future that will complete once the response is available.

encoding ↔ Encoding

read / write, inherited

The Encoding used when writing strings.

followRedirects ↔ bool

read / write

Whether to follow redirects automatically.

hashCode → int

read-only, inherited

The hash code for this object.

headers → HttpHeaders

read-only

Returns the client request headers.

maxRedirects ↔ int

read / write

Set this property to the maximum number of redirects to follow when followRedirects is true. If this number is exceeded an error event will be added with a RedirectException.

method → String

read-only

The method of the request.

persistentConnection ↔ bool

read / write

The requested persistent connection state.

runtimeType → Type

read-only, inherited

A representation of the runtime type of the object.

uri → Uri

read-only

The uri of the request.

Methods

abort([Object? exception, StackTrace? stackTrace]) → void

@Since("2.10")

Aborts the client connection.

add(List<int> data) → void

inherited

Adds byte data to the target consumer, ignoring encoding.

addError(Object error, [StackTrace? stackTrace]) → void

inherited

Passes the error to the target consumer as an error event.

addStream(Stream<List<int>> stream) → Future

inherited

Adds all elements of the given stream.

close() → Future<HttpClientResponse>

override

Close the request for input. Returns the value of done.

flush() → Future

inherited

Returns a Future that completes once all buffered data is accepted by the underlying StreamConsumer.

noSuchMethod(Invocation invocation) → dynamic

inherited

Invoked when a non-existent method or property is accessed.

toString() → String

inherited

A string representation of this object.

write(Object? object) → void

inherited

Converts object to a String by invoking Object.toString and adds the encoding of the result to the target consumer.

writeAll(Iterable objects, [String separator = ""]) → void

inherited

Iterates over the given objects and writes them in sequence.

writeCharCode(int charCode) → void

inherited

Writes the character of charCode.

writeln([Object? object = ""]) → void

inherited

Converts object to a String by invoking Object.toString and writes the result to this, followed by a newline.

Operators

operator ==(Object other) → bool

inherited

The equality operator.