api_manager library
Classes
- ApiManager
- Created by Taohid on 01, March, 2020 Email: taohid32@gmail.com
-
ApiResponse<
T> - every request will wrap its response with this contains api status, body data, and error message
- 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. - Connectivity
- Discover network connectivity configurations: Distinguish between WI-FI and cellular, check WI-FI status and more.
- ConnectivityPlusLinuxPlugin
- The Linux implementation of ConnectivityPlatform.
- DioMixin
- ErrorBody
- error body of http response
- 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.
- 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.
- MultipartFile
-
An upload content that is a part of
MultipartRequest
. This doesn't need to correspond to a physical file. - 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.
-
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.
Enums
- ApiStatus
- Api status state
- ConnectivityResult
- Connection status check result.
- 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
- Http request type
- ResponseType
- Indicates which transformation should be applied to the response data.
Mixins
- OptionsMixin
- The mixin class for options that provides common attributes.
Functions
-
defaultDioExceptionReadableStringBuilder(
DioException e) → String - The default implementation of building a readable string of DioException.
Typedefs
-
AuthTokenListener
= Future<
String> Function() -
enable auth token checker by pass this to
enableAuthTokenCheck
- 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.
- NetworkManagerClientFactory = NetworkManagerClient Function()
- 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.
-
ResponseBodySerializer<
M> = M Function(dynamic jsonMap) -
enable parsing http response using this
request
-
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
.