全部产品

my.downloadFile

下载文件资源到本地。

使用前提

请预先在 阿里云小程序管理中心 > 小程序详情 > 设置 > 开发设置 > 服务器域名白名单 中配置域名白名单。小程序在以下 API 调用时只能与白名单中的域名进行通讯:HTTP 请求(my.request)、上传文件(my.uploadFile)、下载文件(my.downloadFile)和 WebSocket(my.connectSocket)。

image

扫码体验

image.png

示例代码

// API-DEMO page/API/download-file/download-file.json
{
    "defaultTitle": "下载文件"
}

<!-- API-DEMO page/API/download-file/download-file.axml-->
<view class="container">
  <button onTap="download">下载图片并显示</button>
</view>

// API-DEMO page/API/download-file/download-file.js
Page({
  download() {
    my.downloadFile({
      url: 'http://img.alicdn.com/tfs/TB1x669SXXXXXbdaFXXXXXXXXXX-520-280.jpg',
      success({ apFilePath }) {
        my.previewImage({
          urls: [apFilePath],
        });
      },
      fail(res) {
        my.alert({
          content: res.errorMessage || res.error,
        });
      },
    });
  },
})

入参

Object 类型,属性如下:

属性类型必填描述
urlString下载文件地址。
headerObjectHTTP 请求 Header。
successFunction调用成功的回调函数。
failFunction调用失败的回调函数。
completeFunction调用结束的回调函数(调用成功、失败都会执行)。

success 回调函数

入参为 Object 类型,属性如下:

名称类型描述
apFilePathString文件临时存放的位置。

结果码

结果码描述
12下载失败。
13没有权限。