# uploadFile
将本地文件上传到网络。
注意事项:
HTTP 请求 method 为POST
# 支持说明
应用能力 | Android | iOS | PC | 预览效果 |
---|---|---|---|---|
小程序 | 3.3.0 | 3.3.0 | 3.4.0 | 扫码预览 用BoosHi扫码或PC端点击 |
网页应用 | X | X | X | / |
# 输入
继承标准对象输入,扩展属性描述:
名称 | 数据类型 | 必填 | 默认值 | 描述 |
---|---|---|---|---|
url | string | 是 | 开发者服务器地址 仅支持http | https协议 | |
filePath | string | 是 | 要上传文件资源的路径 (本地路径) | |
name | string | 是 | 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容待开发 | |
header | object | 否 | HTTP 请求 Header。Header内 content-type 为 multipart/form-data,不可变更 | |
formData | object | 否 | HTTP 请求中其他额外的 form data 待开发 |
# 输出
success
返回对象的扩展属性:
名称 | 数据类型 | 描述 |
---|---|---|
data | string / object | 返回数据 |
statusCode | number | 返回 HTTP 状态码 |
errMsg | string | 错误信息 |
fail
返回对象的扩展属性:
名称 | 数据类型 | 描述 |
---|---|---|
data | string | 返回数据 |
statusCode | number | 返回 HTTP 状态码 |
errMsg | string | 错误消息 |
返回值:uploadTask
,该对象的方法列表参见下表:
点击下表中的方法名,查看对应API的支持说明、调用方法
方法 | 介绍 |
---|---|
onProgressUpdate(function callback) | 监听上传进度 |
offProgressUpdate(function callback) | 取消监听上传进度 |
abort() | 中断请求任务 |
# 示例代码
const uploadTask = bz.uploadFile({
"url": "https://ship-qa.weizhipin.com/wapi/zphibpm/common/img/upload.json",
"filePath": '', // 可通过bz.filePicker等api获取本地路径
"name": "test.jpeg",
"header": {},
"formData": {
params: '1'
},
success(res) {
bz.showModal({
title: '成功',
content: JSON.stringify(res)
})
},
fail(res) {
bz.showModal({
title: '失败',
content: JSON.stringify(res)
})
}
})
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
success
返回对象示例:
{
"statusCode": 200,
"data": {"error":"xxxx"},
"errMsg": "uploadFile:ok"
}
1
2
3
4
5
2
3
4
5
fail
返回对象示例:
{
"errMsg": "uploadFile:fail CronetError(\"Cronet Error: code=11 xxxxx\")",
"data": "",
"statusCode": 0
}
1
2
3
4
5
2
3
4
5