diff --git a/docs/api/request/network-file.md b/docs/api/request/network-file.md index 5c602cf7affd8719081eb0c0f331b07fb5f45167..2eb75fb52d07da67175e63c54250b22325918084 100644 --- a/docs/api/request/network-file.md +++ b/docs/api/request/network-file.md @@ -1,5 +1,5 @@ ### 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)| |