playx_network
library
Classes
BackgroundTransformer
The default Transformer for Dio .
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.
DefaultApiError
Default api error model that can be received from network response.
can be updated based on the response.
DefaultEnglishExceptionMessage
Default client error messages.
To customize your messages you can override ExceptionMessage the same way as this class and customize the messages.
Dio
Dio enables you to make HTTP requests easily.
DioEventProcessor
This is an EventProcessor, which improves crash reports of DioError s.
It adds information about DioError.requestOptions if present and also about
the inner exceptions.
DioForNative
Implements features for Dio on native platforms.
DioMixin
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
ExceptionMessage
Class that can be extended to implement your own custom errors message.
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FusedTransformer
A Transformer that has a fast path for decoding UTF8-encoded JSON.
If the response is utf8-encoded JSON and no custom decoder is specified in the RequestOptions , this transformer
is significantly faster than the default SyncTransformer and the BackgroundTransformer .
This improvement is achieved by using a fused Utf8Decoder and JsonDecoder to decode the response,
which is faster than decoding the utf8-encoded JSON in two separate steps, since
Dart uses a special fast decoder for this case.
See https://github.com/dart-lang/sdk/blob/5b2ea0c7a227d91c691d2ff8cbbeb5f7f86afdb9/sdk/lib/_internal/vm/lib/convert_patch.dart#L40
The headers class for requests and responses.
HttpClientAdapter
HttpAdapter is 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 Interceptor s.
InterceptorsWrapper
A helper class to create interceptors in ease.
IOHttpClientAdapter
The default HttpClientAdapter for native platforms.
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 should be the last interceptor added,
otherwise modifications by following interceptors will not be logged.
This is because the execution of interceptors is in the order of addition.
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
NetworkError <T >
Generic Wrapper class that represents a failed network response.
NetworkResult <T >
Generic Wrapper class for handling network results.
NetworkSuccess <T >
Generic Wrapper class that represents a successful network response.
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
PlayxNetworkClient
PlayxNetworkClient is a Wrapper around Dio that can perform api request
With better error handling and easily get the result of any api request.
PlayxNetworkClientSettings
This class contains the settings for the PlayxNetworkClient.
You can customize the settings based on your needs.
PlayxNetworkLoggerSettings
Logger settings used to customize what should be logged by the application when performing a request.
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor 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.
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 .
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.
Mixins
OptionsMixin
The mixin class for options that provides common attributes.
