功能描述
通过JS创建文件下载任务
支持格式
Json
请求参数:
字段 | 可选 | 类型及范围 | 说明 |
---|---|---|---|
url | 否 | string | 下载服务器地址,不传或null返回10001错误,为空,空格,错误入参返回10002错误 |
header | 是 | Object | HTTP 请求 Header,Header 中不能设置 Referer,错误入参将忽略 |
timeout | 是 | number | 超时时间,单位为毫秒,错误入参将忽略默认为3000ms |
请求调用示例LightSDK.native.downloadBuild({
url: "http://X.X.X.X:X/download_file.php",
timeout: 5000
},res=>{
var taskid = res.data.taskId;
});
返回字段示例{
"info": {
"error_code": "0",
"error_message": "success"
},
"data": {
"taskId": "BD2114453524"
}
}
返回值说明
字段名 | 字段类型 | 说明 |
---|---|---|
taskId | string | 下载任务句柄 |
注意事项
1.需要在config.js文件中配置插件module.exports = {
plugins:{
"file":{}
}
}
2、该接口只是创建下载任务,并没有真正开始下载,需要启动下载需调用file.downloadFile接口。