vexana library
Classes
- BaseOptions
-
A set of base settings for each
Dio()
. BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose. - CancelToken
-
Controls cancellation of
Dio
's requests. - ClassName
- CustomNoNetworkWidget
- DioMixin
- EmptyModel
- ErrorInterceptorHandler
- The handler for interceptors to handle error occurred during the request.
-
ErrorModel<
T extends INetworkModel< T> ?> - FormData
- A class to create readable "multipart/form-data" streams. It can be used to submit forms and file uploads to http server.
-
IErrorModel<
T extends INetworkModel?> -
INetworkManager<
E extends INetworkModel< E> ?> - The INetworkManager class is an abstract class that defines a contract for managing network operations with models that implement the INetworkModel interface.
-
INetworkModel<
T> - 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.
-
InterceptorState<
T> - Used to pass state between interceptors.
- InterceptorsWrapper
- A helper class to create interceptors in ease.
-
IResponseModel<
T, E extends INetworkModel< E> ?> - LocalFile
- LocalPreferences
- LocalSembast
- MultipartFile
-
An upload content that is a part of
MultipartRequest
. This doesn't need to correspond to a physical file. -
NetworkManager<
E extends INetworkModel< E> ?> -
Network manager provide your requests with
Dio
- NoNetwork
- NoNetworkManager
- Options
- The configuration for a single request. BaseOptions and Options will be merged into one RequestOptions before sending the requests. See Options.compose.
- QueuedInterceptor
- Interceptor in queue.
- QueuedInterceptorsWrapper
- A helper class to create QueuedInterceptor in ease.
- 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.
- ResponseInterceptorHandler
- The handler for interceptors to handle after respond.
-
ResponseModel<
T, E extends INetworkModel< E> ?>
Enums
- DioExceptionType
- The exception enumeration indicates what type of exception has happened during requests.
- FileAccessMode
- The file access mode when downloading a file, corresponds to a subset of dart:io::FileMode.
- InterceptorResultType
- The result type after handled by the interceptor.
- ListFormat
- Specifies the array format (a single parameter with multiple parameter or multiple parameters with the same name). and the separator for array items.
- RequestType
- ResponseType
- Indicates which transformation should be applied to the response data.
Mixins
- CustomRetryMixin
-
IFormDataModel<
T extends INetworkModel> -
The
IFormDataModel
interface is used to convert a model into aFormData
object. TheIFormDataModel
interface is implemented by theINetworkModel
interface. It uses thetoJson
method from theINetworkModel
interface to convert the model into a Map<String, dynamic>. - OptionsMixin
- The mixin class for options that provides common attributes.
Extensions
Functions
-
defaultDioExceptionReadableStringBuilder(
DioException e) → String - The default implementation of building a readable string of DioException.
Typedefs
- 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.
- DioExceptionReadableStringBuilder = String Function(DioException e)
- The readable string builder's signature of DioException.readableStringBuilder.
- DioMediaType = MediaType
-
The type (alias) for specifying the content-type of the
MultipartFile
. - InterceptorErrorCallback = void Function(DioException error, ErrorInterceptorHandler handler)
- The signature of Interceptor.onError.
- InterceptorSendCallback = void Function(RequestOptions options, RequestInterceptorHandler handler)
- The signature of Interceptor.onRequest.
- InterceptorSuccessCallback = void Function(Response response, ResponseInterceptorHandler handler)
- The signature of Interceptor.onResponse.
- ProgressCallback = void Function(int count, int total)
- The type of a progress listening callback when sending or receiving data.
-
RequestEncoder
= FutureOr<
List< Function(String request, RequestOptions options)int> > - The type of a request encoding callback.
-
ResponseDecoder
= FutureOr<
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
.