小程序开放平台

文档中心
基础
路由
跳转
转发
界面
网络
发起请求
上传
下载
downloadFile
WebSocket
支付
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
第三方平台
文件
数据分析
画布

xhs.downloadFile

开发
>
JS API
>
网络
>
下载
>
downloadFile
>
更新时间:2024-11-28 20:16:31

以Promise风格调用: 不支持。

下载文件资源到本地

参数

Object object

属性
类型
默认值
必填
说明
urlstring下载资源的 url(推荐使用 encodeURIComponent 对参数部分进行编码)
headerobjectHTTP 请求的 Header
timeoutnumber超时时间,单位为毫秒
filePathstring指定文件下载后存储的路径 (本地路径)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性
类型
说明
tempFilePathstring临时文件路径 (本地路径)。没传入 filePath 指定文件存储路径时会返回,下载后的文件会存储到一个临时文件
filePathstring用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致
statusCodenumber开发者服务器返回的 HTTP 状态码
errMsgstring

返回值

Object res

属性
类型
说明
codenumber
dataobject
msgstring
xhs.downloadFile({
  url: 'https://example.com/audio/123', //仅为示例,并非真实的资源
  success (res) {
    // 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
    if (res.statusCode === 200) {
      xhs.playVoice({
        filePath: res.tempFilePath
      })
    }
  }
})