BuildRequest<T> class

Constructors

BuildRequest.new(HttpType _httpType, RxNet _rxNet)

Properties

checkNetWork CheckNetWork?
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
onResponse ↔ dynamic Function(Response response)?
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addHeaders(Map<String, dynamic> headers) BuildRequest
addParams(Map<String, dynamic> params) BuildRequest
breakPointDownload({required String savePath, ProgressCallback? onReceiveProgress, Success? success, Failure? failure, Completed? completed, dynamic cancelCallback()?}) → void
下载文件 支持断点下载 savePath 文件保存路径 cancelCallback 取消下载时的回调 下载成功 回调success 获取文件本身
breakPointUploadFile({required String filePath, ProgressCallback? onSendProgress, Success? success, Failure? failure, Completed? completed, dynamic cancelCallback()?, int? start}) → void
上传文件 支持断点上传 filePath 上传文件的路径 cancelCallback 取消下载时的回调 下载成功 回调success 获取文件本身
download({required String savePath, ProgressCallback? onReceiveProgress, Success? success, Failure? failure, Completed? completed}) → void
下载文件 savePath 文件保存路径
execute<T>({Success<T>? success, Failure? failure, Completed? completed}) → void
基于异步回调方式 支持同时请求和缓存策略 对于外部可接收多种状态的数据 建议使用此方式。
executeAsync<T>() Future<RxResult<T>>
外部使用 await 方式调用此方法。 结果从 RxResult 中获取 此方式不支持 同时请求和读取缓存策略。
getCancelToken() CancelToken?
getContentLength(Response response) Future<String?>
获取下载的文件大小 (0 - max) 文件末尾长度
getParams(ParamCallBack callBack) BuildRequest
isRestfulUrl() bool
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeNullValueKeys() BuildRequest
setCacheInvalidationTime(int millisecond) BuildRequest
设置缓存失效时间(毫秒)
setCacheMode(CacheMode cacheMode) BuildRequest
setCancelToken(CancelToken cancelToken) BuildRequest
setCheckNetwork(CheckNetWork checkNetWork) BuildRequest
提供一个检查网络的方法,外部需要自行实现
setEnableGlobalHeader(bool enable) BuildRequest
setFailRetry(bool status) BuildRequest
首次请求失败是否重试 onlyRequest 模式
setHeader(String key, dynamic value) BuildRequest
setIgnoreCacheKey(String key) BuildRequest
setIgnoreCacheKeys(List<String> keys) BuildRequest
setJsonConvert(JsonTransformation convert) BuildRequest
setLoop(bool loop) BuildRequest
setOptionConfig(OptionConfig callBack) BuildRequest
提供一个设置配置的方法,遇到需要额外处理的时候配置
setParam(String key, dynamic value) BuildRequest
setParams(Map<String, dynamic> params) BuildRequest
setParamsToBodyData(bool toBody) BuildRequest
setParamsToFormData(bool toFormData) BuildRequest
setPath(String path) BuildRequest
setRequestIgnoreCacheTime(bool ignoreCache) BuildRequest
开启则忽略缓存校验,直接请求 通常用于 CacheMode.cacheNoneToRequest 在有下拉刷新等操作模式下
setResponseCallBack(dynamic responseCallBack(Response response)) BuildRequest
响应结果 一般情况不会使用
setRestfulUrl(bool restful) BuildRequest
处理 RestfulUrl格式请求 如:xxxx/xxx/weather?city=101030100 结果:xxxx/xxx/weather/city/101030100
setRetryCount(int count) BuildRequest
设置重试次数
setRetryInterval(int interval) BuildRequest
设置重试间隔 -- 毫秒
toBodyData() BuildRequest
toFormData() BuildRequest
用于表单( FormData )。默认 raw json, 其它方式 setOptionConfig自行处理
toString() String
A string representation of this object.
inherited
toUrlEncoded() BuildRequest
用于表单( FormData )。 默认 raw json, 其它方式 setOptionConfig自行处理
upload({ProgressCallback? onSendProgress, Success? success, Failure? failure, Completed? completed}) → void
上传文件

Operators

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