Http class
Http中的泛型T代表BaseResp的data类型、不传泛型则返回原数据 Stream或Future返回的数据均为success为true的BaseResp中的data 错误处理需在Stream的onError或Future的catchError
Constructors
- Http()
-
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpClientAdapter ↔ HttpClientAdapter
-
getter/setter pairinherited
- interceptors → Interceptors
-
no setterinherited
- options ↔ BaseOptions
-
Default Request config. More see
BaseOptions.getter/setter pairinherited - runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- transformer ↔ Transformer
-
transformer allows changes to the request/response data before it is sent/received to/from the server
This is only applicable for request methods 'PUT', 'POST', and 'PATCH'.
getter/setter pairinherited
Methods
-
addInterceptors(
[List< Interceptor> values = const []]) → Http - call before need call baseUrl、signSecret、errorHandler、cacheSaver
-
baseUrl(
String url, String urlForWs) → Http -
cacheReader(
CacheReader reader) → Http -
cacheSaver(
CacheSaver saver) → Http -
clear(
) → void -
Clear the current Dio instance waiting queue.
inherited
-
close(
{bool force = false}) → void -
Shuts down the dio client.
inherited
-
delete<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken}) → Future<Response< T> > -
Handy method to make http DELETE request, which is a alias of
BaseDio.requestOptions.inherited -
deleteUri<
T> (Uri uri, {dynamic data, Options? options, CancelToken? cancelToken}) → Future< Response< T> > -
Handy method to make http DELETE request, which is a alias of
BaseDio.requestOptions.inherited -
download(
String urlPath, dynamic savePath, {ProgressCallback? onReceiveProgress, Map< String, dynamic> ? queryParameters, CancelToken? cancelToken, bool deleteOnError = true, String lengthHeader = Headers.contentLengthHeader, dynamic 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, dynamic 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 -
errorHandler(
ErrorHandler handler) → Http -
fetch<
T> (RequestOptions requestOptions) → Future< Response< T> > -
inherited
-
get<
T> (String path, {Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<Response< T> > -
Handy method to make http GET request, which is a alias of
BaseDio.requestOptions.inherited -
getRx<
T> (String path, {Map< String, dynamic> ? params, Options? options, bool? needToken, bool? wsApi, bool? openCache, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Stream<T> - 异步请求 dispose时取消订阅
-
getSync<
T> (String path, {Map< String, dynamic> ? params, Options? options, bool? needToken, bool? wsApi, bool? openCache, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future<T> - 同步请求 需添加cancelToken dispose时取消
-
getUri<
T> (Uri uri, {Options? options, CancelToken? cancelToken, ProgressCallback? onReceiveProgress}) → Future< Response< T> > -
Handy method to make http GET request, which is a alias of
BaseDio.requestOptions.inherited -
head<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken}) → Future<Response< T> > -
Handy method to make http HEAD request, which is a alias of
BaseDio.requestOptions.inherited -
headUri<
T> (Uri uri, {dynamic data, Options? options, CancelToken? cancelToken}) → Future< Response< T> > -
Handy method to make http HEAD request, which is a alias of
BaseDio.requestOptions.inherited -
isLog(
bool log) → Http -
jsonConverter(
JsonConvert converter) → Http -
lock(
) → void -
Lock the current Dio instance.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
patch<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response< T> > -
Handy method to make http PATCH request, which is a alias of
BaseDio.requestOptions.inherited -
patchUri<
T> (Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future< Response< T> > -
Handy method to make http PATCH request, which is a alias of
BaseDio.requestOptions.inherited -
post<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response< T> > -
Handy method to make http POST request, which is a alias of
BaseDio.requestOptions.inherited -
postRx<
T> (String path, {dynamic data, Options? options, bool? needToken, bool? wsApi, bool? openCache, bool? useFormData, Map< String, dynamic> ? queryParameters, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Stream<T> -
postSync<
T> (String path, {dynamic data, Options? options, bool? needToken, bool? wsApi, bool? openCache, bool? useFormData, Map< String, dynamic> ? queryParameters, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<T> -
postUri<
T> (Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future< Response< T> > -
Handy method to make http POST request, which is a alias of
BaseDio.requestOptions.inherited -
proxy(
String? proxy) → Http -
put<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future<Response< T> > -
Handy method to make http PUT request, which is a alias of
BaseDio.requestOptions.inherited -
putUri<
T> (Uri uri, {dynamic data, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future< Response< T> > -
Handy method to make http PUT request, which is a alias of
BaseDio.requestOptions.inherited -
request<
T> (String path, {dynamic 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, {dynamic data, CancelToken? cancelToken, Options? options, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress}) → Future< Response< T> > -
Make http request with options.
inherited
-
requestWrap<
T> (String path, {dynamic data, Map< String, dynamic> ? queryParameters, Options? options, CancelToken? cancelToken, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress, bool? needToken, bool? wsApi, bool? openCache, bool? useFormData}) → Future<T> -
showLogBtn(
BuildContext context) → void -
signSecret(
String signSecret, String newSignSecret) → Http -
timeout(
int time) → Http -
toString(
) → String -
A string representation of this object.
inherited
-
unlock(
) → void -
Unlock the current Dio instance.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited