ApiClient class abstract

A HttpClient with functionality common when writing API wrappers.

Constructors

ApiClient(Uri apiLocation)
Create a new ApiClient sending requests to apiLocation.

Properties

apiLocation → Uri
The base location of the API.
final
hashCode → int
The hash code for this object.
no setterinherited
inner → Client
The inner Client that will be used to make requests.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the client and cleans up any resources associated with it.
delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<SuccessApiResponse>
Sends an HTTP DELETE request with the given headers to the given URL.
get(Uri url, {Map<String, String>? headers}) → Future<SuccessApiResponse>
Sends an HTTP GET request with the given headers to the given URL.
handleError(ErrorApiResponse response) → FutureOr<ApiResponse>
Called to transform a plain ErrorApiResponse into one with information specific to the API.
handleSuccess(SuccessApiResponse response) → FutureOr<ApiResponse>
Called to transform a plain SuccessApiResponse into one with information specific to the API.
Sends an HTTP HEAD request with the given headers to the given URL.
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<SuccessApiResponse>
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<SuccessApiResponse>
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<SuccessApiResponse>
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.
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.
send(BaseRequest request) → Future<SuccessApiResponse>
Send request and return the response if it is a SuccessApiResponse, or throw if it is an ErrorApiResponse.
sendUnsafe(BaseRequest request) → Future<ApiResponse>
Send request and return the response.
toString() → String
A string representation of this object.
inherited

Operators

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