Work<D, T extends WorkData<D>> class abstract

任务流程的基本模型

D为关联的接口结果数据类型,T为接口响应包装类型WorkData

Mixed in types
Annotations
  • @optionalTypeArgs

Constructors

Work()
const

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onCanceled(T data) FutureOr<bool>
任务被取消时调用
inherited
onCheckParams(T data) FutureOr<bool>
参数合法性检测
inherited
onConfigKey() String?
用于指定全局网络客户端配置的key
inherited
onConfigOptions(T data, WorkRequestOptions options) FutureOr<void>
自定义配置http请求选择项
inherited
onContentType() String?
网络请求body的Content-Type
inherited
onCreateWorkData() → T
创建数据模型对象的实例
inherited
onFailed(T data) FutureOr<bool>
本次任务执行失败后调用
inherited
onFillParams() FutureOr<Map<String, dynamic>?>
填充请求所需的参数
inherited
onFinished(T data) FutureOr<bool>
最后执行的一个方法
inherited
onFromCache(T data) FutureOr<D?>
从缓存加载结果数据
inherited
onFromCacheMessage(T data) String?
从本地缓存加载数据时的结果消息
inherited
onHeaders() FutureOr<Map<String, dynamic>?>
创建并填充请求头
inherited
onHitCache(T data) FutureOr<bool>
是否命中了缓存
inherited
onHttpMethod() HttpMethod
网络请求方法
inherited
onMaxRestart() int
最大重启次数
inherited
onNetworkError(T data) String?
网络连接建立失败时调用,即网络不可用或域名不可达,如dns错误等
inherited
onNetworkRequestFailed(T data) String?
网络连接建立成功,但是响应失败时调用
inherited
onParamsError(T data) String?
参数检测不合法时调用
inherited
onParseFailed(T data) String?
服务器响应数据解析失败后调用
inherited
onPostFillParams(T data, Map<String, dynamic>? params) FutureOr
填充请求所需的后置参数
inherited
onPostQueryParams(T data, Map<String, dynamic>? params) FutureOr<Map<String, dynamic>?>
后置填充请求所需的查询参数
inherited
onQueryParams() FutureOr<Map<String, dynamic>?>
填充请求所需的查询参数
inherited
onRequestFailed(T data) FutureOr<D?>
提取或设置任务执行失败时的返回结果数据
inherited
onRequestFailedMessage(T data) String?
提取或设置任务失败消息
inherited
onRequestResult(T data) bool
提取任务执行结果
inherited
onRequestSuccessful(T data) FutureOr<D?>
提取任务执行成功时返回的真正有用结果数据
inherited
onRequestSuccessfulMessage(T data) String?
提取或设置任务成功消息
inherited
onResponseType() ResponseType?
表示期望以哪种格式(方式)接受响应数据
inherited
onStarted(T data) FutureOr<void>
网络请求执行前调用
inherited
onSuccessful(T data) FutureOr<bool>
本次任务执行成功后调用
inherited
onUrl() String
网络请求地址
inherited
onWorkRequest(WorkRequestOptions options) WorkRequest
返回请求实现方法
inherited
start({int retry = 0, OnProgress? onSendProgress, OnProgress? onReceiveProgress}) WorkFuture<D, T>
启动任务
override
toString() String
A string representation of this object.
inherited

Operators

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