RestClient class Get started Configuration Clients

Creates a client that returns RestResponse for a request.

The RestResponse will use only serializer, and JsonModelSerializer.common when deserializing a response body and it does not inherit from serializers in the WrapperClient tree.

Inheritance

Constructors

RestClient(Client inner, {JsonModelSerializer? serializer})

Properties

hashCode → int
The hash code for this object.
no setterinherited
inner → Client
The inner Client of this WrapperClient.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serializer ↔ JsonModelSerializer?
The serializer that serializes and deserializes JSON objects to and from Dart classes.
getter/setter pair

Methods

close({bool force = true, Client? keepAliveHttpClient}) → void
Closes the client and cleans up any resources associated with it.
inherited
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<RestResponse>
Sends an HTTP DELETE request with the given headers to the given URL.
get(Uri url, {Map<String, String>? headers}) → Future<RestResponse>
Sends an HTTP GET request with the given headers to the given URL.
Sends an HTTP HEAD request with the given headers to the given URL.
multipart(MultipartRequest request) → Future<RestResponse>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<RestResponse>
Sends an HTTP PATCH request with the given headers and body to the given URL.
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<RestResponse>
Sends an HTTP POST request with the given headers and body to the given URL.
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<RestResponse>
Sends an HTTP PUT request with the given headers and body to the given URL.
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
inherited
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
inherited
send(BaseRequest request) → Future<StreamedResponse>
Sends an HTTP request and asynchronously returns the response.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited