TrackedDioClient class

Use this client to track requests made via the dio package (version <5). For Dio version 5 and above, see TrackedDioInterceptor.

import 'package:dio/dio.dart';

try {
  final dio = Dio();
  final client = TrackedDioClient(dio);
  final response = await client.post(urlString, data: "{"foo": "bar"}");
  // handle response
} catch (e) {
  // handle error
}

Constructors

TrackedDioClient(Dio _dioClient, {bool addCorrelationHeaders = true})

Properties

addCorrelationHeaders → bool

final

hashCode → int

The hash code for this object.

no setter, inherited

httpClientAdapter ↔ HttpClientAdapter

The adapter that the instance is using.

getter/setter pair, inherited

interceptors → Interceptors

Each Dio instance has a interceptor group by which you can intercept requests or responses before they are ended.

no setter, inherited

options ↔ BaseOptions

The base request config for the instance.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

tracker ↔ RequestTracker?

getter/setter pair

transformer ↔ Transformer

The default Transformer that transfers requests and responses into corresponding content to send.

getter/setter pair, inherited

Methods

close({bool force = false}) → void

Shuts down the dio client.

inherited

delete<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken}) → Future<Response<T>>

Convenience method to make an HTTP DELETE request.

inherited

deleteUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>

Convenience method to make an HTTP DELETE request with Uri.

inherited

download(String urlPath, dynamic savePath, {ProgressCallback? onReceiveProgress, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, Object? data, Options? options}) → Future<Response>

Download the file and save it in local. The default http method is "GET", you can custom it by Options.method.

inherited

downloadUri(Uri uri, dynamic savePath, {ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, Object? data, Options? options}) → Future<Response>

Download the file and save it in local. The default http method is "GET", you can custom it by Options.method.

inherited

fetch<T>(RequestOptions requestOptions) → Future<Response<T>>

The eventual method to submit requests. All callers for requests should eventually go through this method.

inherited

get<T>(String path, {Map<String, dynamic>? queryParameters, Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP GET request.

inherited

getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP GET request with Uri.

inherited

head<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken}) → Future<Response<T>>

Convenience method to make an HTTP HEAD request.

inherited

headUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>

Convenience method to make an HTTP HEAD request with Uri.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patch<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP PATCH request.

inherited

patchUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP PATCH request with Uri.

inherited

post<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP POST request.

inherited

postUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP POST request with Uri.

inherited

put<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP PUT request.

inherited

putUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Convenience method to make an HTTP PUT request with Uri.

inherited

request<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Make HTTP request with options.

requestUri<T>(Uri uri, {Object? data, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>

Make http request with options with Uri.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited