IWebRquestMr

更新记录

版本 日期 修改人 修改内容
1.0.0 2021年3月1日 蔺浪(510525) 新建文档

IWebRquestMr

using Autofac;
using VLabDownload;

//Get instance of IWebRquestMr
var webRquestMr = DependencyInjection.Container.Resolve<IWebRquestMr>();

概况

组件版本

  • VLabDownload 1.1.10(尚未发布)

接口状态

  • 基于应用提测通过
  • 组件接口测试中

请求接口(Put)

接口签名:

string Put(string url, int timeOut = 120, int priority = 0, Dictionary<string, string> headData = null, Action<float> progressCallback = null, Action<string> finishCallback = null, Action<int, string> errorCallback = null)

接口说明:

  • Put网络请求

参数说明:

参数名 类型 说明
url string 网络地址
timeOut int 网络超时(s)
priority int 优先级(数值越小优先级越高)
headData Dictionary<string, string> 头部数据
progressCallback Action<float> 进度回调(进度)
finishCallback Action<string> 完成回调(响应结果)
errorCallback Action<ErrorInfo> 错误回调(错误码,错误信息)

返回值说明

类型 说明
string 任务实例GUID

请求接口(Post)

接口签名:

string Post(string url, string postData, int timeOut = 120, int priority = 0, Dictionary<string, string> headData = null, Action<float> progressCallback = null, Action<string> finishCallback = null, Action<int, string> errorCallback = null)

接口说明:

  • Post网络请求

参数说明:

参数名 类型 说明
url string 网络地址
postData string post数据
timeOut int 网络超时(s)
priority int 优先级(数值越小优先级越高)
headData Dictionary<string, string> 头部数据
progressCallback Action<float> 进度回调(进度)
finishCallback Action<string> 完成回调(响应结果)
errorCallback Action<ErrorInfo> 错误回调(错误码,错误信息)

返回值说明

类型 说明
string 任务实例GUID

下载接口

接口签名:

string DownLoad(string url, string localPath, int timeOut = 360, int priority = 0, Action<float> progressCallback = null, Action<string> finishCallback = null, Action<int, string> errorCallback = null)

接口说明:

  • 下载网络文件

参数说明:

参数名 类型 说明
url string 网络地址
localPath string 本地存储路径
timeOut int 网络超时(s)
priority int 优先级(数值越小优先级越高)
progressCallback Action<float> 进度回调(进度)
finishCallback Action<string> 完成回调(文件存储地址)
errorCallback Action<ErrorInfo> 错误回调(错误码,错误信息)

返回值说明

类型 说明
string 任务实例GUID

下载接口(tmpFileName)

接口签名:

string DownLoad(string url, string localPath, string tmpFileName, int timeOut = 360, int priority = 0, Action<float> progressCallback = null, Action<string> finishCallback = null, Action<int, string> errorCallback = null)

接口说明:

  • 下载网络文件

参数说明:

参数名 类型 说明
url string 网络地址
localPath string 本地存储路径
tmpFileName string 临时文件名(含扩展名)
timeOut int 网络超时(s)
priority int 优先级(数值越小优先级越高)
progressCallback Action<float> 进度回调(进度)
finishCallback Action<string> 完成回调(文件存储地址)
errorCallback Action<ErrorInfo> 错误回调(错误码,错误信息)

返回值说明

类型 说明
string 任务实例GUID

暂停任务

接口签名:

int Pause(string guid);

接口说明:

  • 暂停任务

参数说明:

参数名 类型 说明
string string 任务实例GUID

返回值说明

类型 说明
int 结果码(0:操作成功;-1:操作失败)

恢复任务

接口签名:

int Resume(string guid);

接口说明:

  • 恢复任务

参数说明:

参数名 类型 说明
string string 任务实例GUID

返回值说明

类型 说明
int 结果码(0:操作成功;-1:操作失败)

设置任务优先级

接口签名:

int SetPriority(string guid, int priority);

接口说明:

  • 设置任务优先级(已经运行的任务不受影响)

参数说明:

参数名 类型 说明
string string 任务实例GUID

返回值说明

类型 说明
int 结果码(0:操作成功;-1:操作失败)

取消任务

接口签名:

int Cancel(string guid);

接口说明:

  • 取消任务

参数说明:

参数名 类型 说明
string string 任务实例GUID

返回值说明

类型 说明
int 结果码(0:操作成功;-1:操作失败)