xxf_http
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 .
Body
Use this annotation on a service method param when you want to directly control the request body
of a POST/PUT request (instead of sending in as request parameters or form-style request
body).
BodyExtra
Use this annotation on a service method param when you want to add individual fields
to the request body without defining a complete DTO class. This is useful when you
need to include additional fields in the request body alongside existing data, or when
you only need to send a few specific fields without creating a full data transfer object.
CacheControl
CallAdapter <R , T >
Adapts a Call with return type R into the type of T.
e.g. Future<User> to Future<Result<User>>
CancelRequest
CancelToken
Controls cancellation of Dio 's requests.
ClientAdapter
class MyClientAdapter implements ClientAdapter {
@override
Dio createClient() {
return Dio(BaseOptions(baseUrl: 'https://api.example.com'));
}
}
DELETE
Make a DELETE request
Dio
Dio enables you to make HTTP requests easily.
DioMixin
DioOptions
DioResponseType
ErrorInterceptorHandler
The handler for interceptors to handle error occurred during the request.
Extra data that will be passed to dio's request, response, transformer and interceptors.
Extra data that will be passed to dio's request, response, transformer and interceptors.
Simple Example:
Field
Named pair for a form request.
FormData
A class to create readable "multipart/form-data" streams.
It can be used to submit forms and file uploads to http server.
FormUrlEncoded
Denotes that the request body will use form URL encoding. Fields should be declared as
parameters and annotated with Field .
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
GET
Make a GET request
HEAD
Make a HEAD request
Replaces the header with the value of its target.
Adds headers specified in the value map.
HttpClientAdapter
HttpAdapter is a bridge between Dio and HttpClient .
HttpMethod
A holder that includes all http methods which are supported by retrofit.
HttpResponse <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 Interceptor s.
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 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.
Method
MultiPart
Denotes that the request body is multi-part. Parts should be declared as parameters and
annotated with Part .
MultipartFile
An upload content that is a part of MultipartRequest.
This doesn't need to correspond to a physical file.
NoBody
Use this annotation on a service method param when you want to indicate that no body should be
generated for POST/PUT/DELETE requests.
OPTIONS
Make a OPTIONS request
Options
The configuration for a single request.
BaseOptions and Options will be merged into one RequestOptions before
sending the requests. See Options.compose .
ParseErrorLogger
Base class for logging errors that occur during parsing of response data.
Part
Denotes a single part of a multi-part request.
Part parameters may not be null.
PATCH
Make a PATCH request
Path
Named replacement in a URL path segment.
POST
Make a POST request
PreventNullToAbsent
Prevents null values from being converted to absent values in generated code for body.
PUT
Make a PUT request
Queries
Query parameter keys and values appended to the URL.
Query
Query parameter appended to the URL.
QueuedInterceptor
Interceptor in queue.
QueuedInterceptorsWrapper
A helper class to create QueuedInterceptor in ease.
ReceiveProgress
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.
RestApi
Define an API.
SendProgress
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.
Extra data that will be passed to Dio's request, response, transformer, and interceptors.
Extend TypedExtras and define fields that correspond to the keys passed into extras.
The values of these fields will be derived from the data passed into your subclass.
UseCallAdapter
By annotating a method with @UseCallAdapter, you can specify a custom adapter
class where you can adapt a call to another response wrapper
UserClientAdapter
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.
Parser
Define how to parse response json
If you want to support more, PR is welcome
ResponseType
Indicates which transformation should be applied to the response data.
Mixins
OptionsMixin
The mixin class for options that provides common attributes.
