Client class

The interface for HTTP clients that take care of maintaining persistent connections across multiple requests to the same server. If you only need to send a single request, it's usually easier to use head, get, post, put, patch, or delete instead.

When creating an HTTP client class with additional functionality, you must extend BaseClient rather than Client. In most cases, you can wrap another instance of Client and add functionality on top of that. This allows all classes implementing Client to be mutually composable.

Implementers

Constructors

Client()
Creates a new client. [...]
factory

Properties

hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

close() → void
Closes the client and cleans up any resources associated with it. It's important to close each client when it's done being used; failing to do so can cause the Dart process to hang.
delete(dynamic url, { Map<String, String> headers }) Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL, which can be a Uri or a String. [...]
get(dynamic url, { Map<String, String> headers }) Future<Response>
Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String. [...]
Sends an HTTP HEAD request with the given headers to the given URL, which can be a Uri or a String. [...]
patch(dynamic url, { Map<String, String> headers, dynamic body, Encoding encoding }) Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL, which can be a Uri or a String. [...]
post(dynamic url, { Map<String, String> headers, dynamic body, Encoding encoding }) Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL, which can be a Uri or a String. [...]
put(dynamic url, { Map<String, String> headers, dynamic body, Encoding encoding }) Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL, which can be a Uri or a String. [...]
read(dynamic url, { Map<String, String> headers }) Future<String>
Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String, and returns a Future that completes to the body of the response as a String. [...]
readBytes(dynamic url, { Map<String, String> headers }) Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL, which can be a Uri or a String, and returns a Future that completes to the body of the response as a list of bytes. [...]
send(BaseRequest request) Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) bool
The equality operator. [...]
inherited