HttpClientWithInterceptor class
Class to be used by the user to set up a new http.Client
with interceptor supported.
call the build()
constructor passing in the list of interceptors.
Example:
HttpClientWithInterceptor httpClient = HttpClientWithInterceptor.build(interceptors: [
Logger(),
]);
Then call the functions you want to, on the created http
object.
httpClient.get(...);
httpClient.post(...);
httpClient.put(...);
httpClient.delete(...);
httpClient.head(...);
httpClient.patch(...);
httpClient.read(...);
httpClient.readBytes(...);
httpClient.send(...);
httpClient.close();
Don't forget to close the client once you are done, as a client keeps the connection alive with the server.
Constructors
-
HttpClientWithInterceptor.build({required List<
InterceptorContract> interceptors, Duration? requestTimeout, RetryPolicy? retryPolicy, bool badCertificateCallback(X509Certificate, String, int)?, String findProxy(Uri)?, Client? client}) -
factory
Properties
- badCertificateCallback ↔ bool Function(X509Certificate, String, int)?
-
getter/setter pair
- findProxy ↔ String Function(Uri)?
-
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
-
interceptors
↔ List<
InterceptorContract> -
getter/setter pair
- requestTimeout ↔ Duration?
-
getter/setter pair
- retryPolicy ↔ RetryPolicy?
-
getter/setter pair
- 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<Response> - Sends an HTTP DELETE request with the given headers to the given URL.
-
get(
Uri url, {Map< String, String> ? headers, Map<String, String> ? params}) → Future<Response> - Sends an HTTP GET request with the given headers to the given URL.
-
head(
Uri url, {Map< String, String> ? headers}) → Future<Response> - 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<Response> - 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<Response> - 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<Response> - 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< 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