DioMixin class abstract

Implemented types

• Dio

Implementers

• DioForBrowser
• DioForNative

Constructors

DioMixin()

Properties

hashCode → int

The hash code for this object.

read-only, inherited

httpClientAdapter ↔ HttpClientAdapter

read / write, override

interceptors → Interceptors

read-only, override

options ↔ BaseOptions

Default Request config. More see BaseOptions.

read / write, override

runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

transformer ↔ Transformer

transformer allows changes to the request/response data before it is sent/received to/from the server This is only applicable for request methods 'PUT', 'POST', and 'PATCH'.

read / write, override

Methods

clear() → void

Clear the current Dio instance waiting queue.

override

close({bool force = false}) → void

Shuts down the dio client.

override

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

Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.

override

download(String urlPath, dynamic savePath, {ProgressCallback? onReceiveProgress, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, dynamic 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.

override

downloadUri(Uri uri, dynamic savePath, {ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, dynamic 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.

override

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

override

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

Handy method to make http GET request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http GET request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.

override

lock() → void

Lock the current Dio instance.

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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

Handy method to make http PATCH request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http PATCH request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http POST request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http POST request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http PUT request, which is a alias of BaseDio.requestOptions.

override

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

Handy method to make http PUT request, which is a alias of BaseDio.requestOptions.

override

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

Make http request with options.

override

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

Make http request with options.

override

toString() → String

A string representation of this object.

inherited

unlock() → void

Unlock the current Dio instance.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

assureDioError(dynamic err, RequestOptions requestOptions, [StackTrace? sourceStackTrace]) → DioError

assureResponse<T>(dynamic response, [RequestOptions? requestOptions]) → Response<T>

checkCancelled(CancelToken? cancelToken) → void

checkIfNeedEnqueue<T>(Lock lock, _WaitCallback<T> callback) → FutureOr<T>

checkOptions(String method, Options? options) → Options

listenCancelForAsyncTask<T>(CancelToken? cancelToken, Future<T> future) → Future<T>