dio library
A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use.
A open source project authorized by https://flutterchina.club.
Classes
- BaseOptions
-
The common config for the Dio instance.
dio.optionsis a instance of BaseOptions - CancelToken
- You can cancel a request by using a cancel token. One token can be shared with different requests. when a token's cancel method invoked, all requests with this token will be cancelled.
- CookieManager
- DefaultHttpClientAdapter
- The default HttpClientAdapter for Dio is DefaultHttpClientAdapter.
- DefaultTransformer
- Dio
- A powerful Http client for Dart, which supports Interceptors, Global configuration, FormData, File downloading etc. and Dio is very easy to use. [...]
- DioHttpHeaders
- FormData
- A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
- HttpClientAdapter
- HttpAdapter is a bridge between Dio and HttpClient. [...]
- Interceptor
-
Dio instance may have interceptor(s) by which you can intercept
requests or responses before they are handled by
thenorcatchError. - Interceptors
- InterceptorsWrapper
- Lock
- Add lock/unlock API for interceptors.
- LogInterceptor
- Options
- Every request can pass an Options object which will be merged with Dio.options
- RequestOptions
-
Response<
T> - Response describes the http Response info.
- ResponseBody
- 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'. [...]
- UploadFileInfo
- Describes the info of file to upload.
Enums
- DioErrorType
- ResponseType
- ResponseType indicates which transformation should be automatically applied to the response data by Dio.
Typedefs
-
CancelWrapper(
Future) → Future -
InterceptorErrorCallback(
DioError e) → dynamic -
InterceptorSendCallback(
RequestOptions options) → dynamic -
InterceptorSuccessCallback(
Response e) → dynamic -
JsonDecodeCallback(
String) → dynamic - The default Transformer for Dio. If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the DefaultTransformer by setting the dio.Transformer.
-
OnHttpClientCreate(
HttpClient client) → dynamic -
ProgressCallback(
int count, int total) → void - Callback to listen the progress for sending/receiving data. [...]
-
ValidateStatus(
int status) → bool -
VoidCallback(
) → dynamic
Exceptions / Errors
- DioError
- DioError describes the error info when request failed.