ApiManager class

Inheritance

Constructors

ApiManager({required String baseUrl, int connectTimeout = 30, int receiveTimeout = 30, Map<String, dynamic>? headers, List<Interceptor> interceptors = const [], HttpClient createHttpClient()?, Future<String> loadMockAsset(String)?})

Properties

hashCode → int
The hash code for this object.
no setterinherited
httpClientAdapter ↔ HttpClientAdapter
The adapter that the instance is using.
getter/setter pairinherited
interceptors → Interceptors
Each Dio instance has a interceptor group by which you can intercept requests or responses before they are ended.
no setterinherited
loadMockAsset → (Future<String> Function(String)?)
loadMockAsset is a function that returns a Future<String> of the mock file contents.
final
options ↔ BaseOptions
The base request config for the instance.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformer ↔ Transformer
The default Transformer that transfers requests and responses into corresponding content to send.
getter/setter pairinherited

Methods

close({bool force = false}) → void
Shuts down the dio client.
inherited
delete<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, Duration? cacheExpiresIn, MockReplyParams? mockReplyParams}) → Future<Response<T>>
Convenience method to make an HTTP DELETE request.
override
deleteUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>
Convenience method to make an HTTP DELETE request with Uri.
inherited
download(String urlPath, dynamic savePath, {ProgressCallback? onReceiveProgress, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, Object? data, Options? options}) → Future<Response>
Download the file and save it in local. The default http method is "GET", you can custom it by Options.method.
inherited
downloadUri(Uri uri, dynamic savePath, {ProgressCallback? onReceiveProgress, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, Object? data, Options? options}) → Future<Response>
Download the file and save it in local. The default http method is "GET", you can custom it by Options.method.
inherited
fetch<T>(RequestOptions requestOptions) → Future<Response<T>>
The eventual method to submit requests. All callers for requests should eventually go through this method.
inherited
get<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress, Duration? cacheExpiresIn, MockReplyParams? mockReplyParams}) → Future<Response<T>>
Convenience method to make an HTTP GET request.
override
getUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Convenience method to make an HTTP GET request with Uri.
inherited
Convenience method to make an HTTP HEAD request.
inherited
headUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken}) → Future<Response<T>>
Convenience method to make an HTTP HEAD request with Uri.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
patch<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, Duration? cacheExpiresIn, MockReplyParams? mockReplyParams}) → Future<Response<T>>
Convenience method to make an HTTP PATCH request.
override
patchUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Convenience method to make an HTTP PATCH request with Uri.
inherited
post<T>(String path, {dynamic data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, Duration? cacheExpiresIn, MockReplyParams? mockReplyParams}) → Future<Response<T>>
Convenience method to make an HTTP POST request.
override
postUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Convenience method to make an HTTP POST request with Uri.
inherited
put<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, Duration? cacheExpiresIn, MockReplyParams? mockReplyParams}) → Future<Response<T>>
Convenience method to make an HTTP PUT request.
override
putUri<T>(Uri uri, {Object? data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Convenience method to make an HTTP PUT request with Uri.
inherited
request<T>(String path, {Object? data, Map<String, dynamic>? queryParameters, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Make HTTP request with options.
inherited
requestUri<T>(Uri uri, {Object? data, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response<T>>
Make http request with options with Uri.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited