dio library Migration Guide Plugins
A powerful HTTP client for Dart and Flutter, which supports global settings, Interceptors, FormData, aborting and canceling a request, files uploading and downloading, requests timeout, custom adapters, etc.
Classes
- BackgroundTransformer
- The default Transformer for Dio.
- BaseOptions
- The base config for the Dio instance, used by Dio.options.
- CancelToken
- Controls cancellation of Dio's requests.
- Dio
- Dio enables you to make HTTP requests easily.
- DioMixin
- ErrorInterceptorHandler
- The handler for interceptors to handle error occurred during the request.
- FormData
- A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
- Headers
- The headers class for requests and responses.
- HttpClientAdapter
-
HttpAdapteris a bridge between Dio and HttpClient. - Interceptor
- Interceptor helps to deal with RequestOptions, Response, and DioException during the lifecycle of a request before it reaches users.
- Interceptors
- A Queue-Model list for Interceptors.
- InterceptorsWrapper
- A helper class to create interceptors in ease.
-
ListParam<
T> - Indicates a param being used as queries or form data, and how does it gets formatted.
- LogInterceptor
- LogInterceptor is used to print logs during network requests. It's better to add LogInterceptor to the tail of the interceptor queue, otherwise the changes made in the interceptor behind A will not be printed out. This is because the execution of interceptors is in the order of addition.
- MultipartFile
-
A file to be uploaded as part of a
MultipartRequest. This doesn't need to correspond to a physical file. - Options
- Every request can pass an Options object which will be merged with Dio.options
- QueuedInterceptor
- Interceptor in queue.
- QueuedInterceptorsWrapper
- A helper class to create queued-interceptors in ease.
- RedirectRecord
- A record that records the redirection happens during requests, including status code, request method, and the location.
- RequestInterceptorHandler
- The handler for interceptors to handle before the request has been sent.
- RequestOptions
- The internal request option class that is the eventual result after BaseOptions and Options are composed.
-
Response<
T> - The Response class contains the payload (could be transformed) that respond from the request, and other information of the response.
- ResponseBody
- The response wrapper class for adapters.
- ResponseInterceptorHandler
- The handler for interceptors to handle after respond.
- SyncTransformer
- If you want to custom the transformation of request/response data, you can provide a Transformer by your self, and replace the transformer by setting the Dio.transformer.
- Transformer
- Transformer allows changes to the request/response data before it is sent/received to/from the server.
Mixins
- OptionsMixin
- The mixin class for options that provides common attributes.
Enums
- DioExceptionType
- The exception enumeration indicates what type of exception has happened during requests.
- ListFormat
- Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.
- ResponseType
- Indicates which transformation should be applied to the response data.
Typedefs
- DefaultTransformer = SyncTransformer
- DioError = DioException
- DioError describes the exception info when a request failed.
- DioErrorType = DioExceptionType
- Deprecated in favor of DioExceptionType and will be removed in future major versions.
-
HeaderForEachCallback
= void Function(String name, List<
String> values) - The signature that iterates header fields.
- InterceptorErrorCallback = void Function(DioException e, ErrorInterceptorHandler handler)
- The signature of Interceptor.onError.
- InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)
- The signature of Interceptor.onRequest.
- InterceptorSuccessCallback = void Function(Response e, ResponseInterceptorHandler handler)
- The signature of Interceptor.onResponse.
- JsonDecodeCallback = FutureOr Function(String)
- The callback definition for decoding a JSON string.
-
JsonEncodeCallback
= FutureOr<
String> Function(Object) - The callback definition for encoding a JSON object.
- ProgressCallback = void Function(int count, int total)
- The type of a progress listening callback when sending or receiving data.
-
RequestEncoder
= List<
int> Function(String request, RequestOptions options) - The type of a response encoding callback.
-
ResponseDecoder
= String? Function(List<
int> responseBytes, RequestOptions options, ResponseBody responseBody) - The type of a response decoding callback.
- ValidateStatus = bool Function(int? status)
- The type of a response status code validate callback.
Exceptions / Errors
- DioException
- DioException describes the exception info when a request failed.
-
NotNullableError<
T> -
A TypeError thrown by
_checkNotNullable.