DioForBrowser class

Implemented types
Mixed-in types

Constructors

DioForBrowser([BaseOptions? options])
Create Dio instance with default Options. It's mostly just one Dio instance in your application.

Properties

hashCode int
The hash code for this object.
no setterinherited
httpClientAdapter HttpClientAdapter
getter/setter pairinherited
interceptors Interceptors
no setterinherited
options BaseOptions
Default Request config. More see BaseOptions.
getter/setter pairinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
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'.
getter/setter pairinherited

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>>
Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.
inherited
deleteUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) Future<Response<T>>
Handy method to make http DELETE request, which is a alias of BaseDio.requestOptions.
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>>
inherited
get<T>(String path, {Map<String, dynamic>? queryParameters, Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) Future<Response<T>>
Handy method to make http GET request, which is a alias of BaseDio.requestOptions.
inherited
getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) Future<Response<T>>
Handy method to make http GET request, which is a alias of BaseDio.requestOptions.
inherited
Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.
inherited
headUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) Future<Response<T>>
Handy method to make http HEAD request, which is a alias of BaseDio.requestOptions.
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>>
Handy method to make http PATCH request, which is a alias of BaseDio.requestOptions.
inherited
patchUri<T>(Uri uri, {Object? 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.
inherited
post<T>(String path, {Object? 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.
inherited
postUri<T>(Uri uri, {Object? 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.
inherited
put<T>(String path, {Object? 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.
inherited
putUri<T>(Uri uri, {Object? 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.
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.
inherited
requestUri<T>(Uri uri, {Object? data, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) Future<Response<T>>
Make http request with options.
inherited
toString() String
A string representation of this object.
inherited

Operators

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