Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-zh
提交
5f6f0e57
unidocs-zh
项目概览
DCloud
/
unidocs-zh
通知
3216
Star
106
Fork
815
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
94
列表
看板
标记
里程碑
合并请求
70
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
unidocs-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
94
Issue
94
列表
看板
标记
里程碑
合并请求
70
合并请求
70
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
5f6f0e57
编写于
4月 17, 2023
作者:
DCloud-WZF
💬
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
docs(network-file): arguments update
上级
b2424fc1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
13 addition
and
10 deletion
+13
-10
docs/api/request/network-file.md
docs/api/request/network-file.md
+13
-10
未找到文件。
docs/api/request/network-file.md
浏览文件 @
5f6f0e57
### uni.uploadFile(OBJECT)
将本地资源上传到开发者服务器,客户端发起一个
``POST``
请求,其中
``content-type``
为
``multipart/form-data``
。
将本地资源上传到开发者服务器,客户端发起一个
``POST``
请求,其中
``content-type``
为
``multipart/form-data``
。
如页面通过
[
uni.chooseImage
](
api/media/image?id=chooseimage
)
等接口获取到一个本地资源的临时文件路径后,可通过此接口将本地资源上传到指定服务器。另外选择和上传非图像、视频文件参考:
[
https://ask.dcloud.net.cn/article/35547
](
https://ask.dcloud.net.cn/article/35547
)
。
> 在各个小程序平台运行时,网络相关的 API 在使用前需要配置域名白名单。
...
...
@@ -19,7 +19,7 @@
|filePath|String|是(files和filePath选其一)|要上传文件资源的路径。||
|name|String|是|文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容||
|header|Object|否|HTTP 请求 Header, header 中不能设置 Referer。||
|timeout|Number|否|超时时间,单位 ms|H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)|
|timeout|Number|否|超时时间,单位 ms|H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)
、微信小程序、支付宝小程序、字节小程序
|
|formData|Object|否|HTTP 请求中其他额外的 form data||
|success|Function|否|接口调用成功的回调函数||
|fail|Function|否|接口调用失败的回调函数||
...
...
@@ -97,7 +97,7 @@ uploadTask.abort();
|:-|:-|:-|
|abort||中断上传任务|
|onProgressUpdate|callback|监听上传进度变化|
|onHeadersReceived|callback|监听 HTTP Response Header 事件。会比请求完成事件更早,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/UploadTask.onHeadersReceived.html
)
|
|onHeadersReceived|callback|监听 HTTP Response Header 事件。会比请求完成事件更早,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/UploadTask.onHeadersReceived.html
)
|
|offProgressUpdate|callback|取消监听上传进度变化事件,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/UploadTask.offProgressUpdate.html
)
|
|offHeadersReceived|callback|取消监听 HTTP Response Header 事件,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/UploadTask.offHeadersReceived.html
)
|
...
...
@@ -152,20 +152,23 @@ uni.chooseImage({
|:-|:-|:-|:-|:-|
|url|String|是|下载资源的 url| |
|header|Object|否|HTTP 请求 Header, header 中不能设置 Referer。| |
|timeout|Number|否|超时时间,单位 ms|H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)|
|timeout|Number|否|超时时间,单位 ms|H5(HBuilderX 2.9.9+)、APP(HBuilderX 2.9.9+)、微信小程序、支付宝小程序、字节小程序|
|filePath|string|否|指定文件下载后存储的路径 (本地路径)|微信小程序(IOS小程序保存到相册需要添加此字段才可以正常保存)、QQ小程序、支付宝小程序、百度小程序、字节小程序、飞书小程序|
|success|Function|否|下载成功后以 tempFilePath 的形式传给页面,res = {tempFilePath: '文件的临时路径'}| |
|fail|Function|否|接口调用失败的回调函数| |
|complete|Function|否|接口调用结束的回调函数(调用成功、失败都会执行)| |
|filePath|string|否|指定文件下载后存储的路径 (本地路径)|微信小程序(IOS小程序保存到相册需要添加此字段才可以正常保存)|
**注:文件的临时路径,在应用本次启动期间可以正常使用,如需持久保存,需在主动调用 [uni.saveFile](/api/file/file?id=savefile),才能在应用下次启动时访问得到。**
**success 返回参数说明**
|参数|类型|说明|
|:-|:-|:-|
|tempFilePath|String|临时文件路径,下载后的文件会存储到一个临时文件|
|statusCode|Number|开发者服务器返回的 HTTP 状态码|
|参数|类型|说明|平台差异说明|
|:-|:-|:-|:-|
|tempFilePath|String|临时文件路径,下载后的文件会存储到一个临时文件|微信小程序、支付宝小程序、百度小程序、字节小程序、飞书小程序|
|statusCode|Number|开发者服务器返回的 HTTP 状态码|微信小程序、QQ小程序、百度小程序、字节小程序、飞书小程序|
|apFilePath|String|下载文件保存的路径(本地临时文件)。入参未指定 filePath 的情况下可用|支付宝小程序|
|filePath|String|用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致|微信小程序、支付宝小程序、字节小程序、飞书小程序|
|fileContent|Buffer|文件内容|QQ小程序|
**注意**
-
网络请求的
``超时时间``
可以统一在
``manifest.json``
中配置
[
networkTimeout
](
/collocation/manifest?id=networktimeout
)
。
...
...
@@ -205,7 +208,7 @@ downloadTask.abort();
|:-|:-|:-|:-|
|abort||中断下载任务|
*
|
|onProgressUpdate|callback|监听下载进度变化|
*
|
|onHeadersReceived|callback|监听 HTTP Response Header 事件,会比请求完成事件更早,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/DownloadTask.onHeadersReceived.html
)
| |
|onHeadersReceived|callback|监听 HTTP Response Header 事件,会比请求完成事件更早,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/DownloadTask.onHeadersReceived.html
)
| |
|offProgressUpdate|callback|取消监听下载进度变化事件,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/DownloadTask.offProgressUpdate.html
)
|
|offHeadersReceived|callback|取消监听 HTTP Response Header 事件,仅
`微信小程序平台`
支持,
[
规范详情
](
https://developers.weixin.qq.com/miniprogram/dev/api/DownloadTask.offHeadersReceived.html
)
| |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录