downloadtask my.downloadfile(object object)

主体： 企业支付宝小程序 、 个人支付宝小程序

相关文档： 网络 api 使用须知 、 本地文件

object object

查看示例

success 回调函数

参数

object res

fail 回调函数

参数

object err

downloadtask

支付宝客户端 10.1.35 及以上版本，低版本需做 兼容处理。

可用于获取 http 响应头，监听上传进度变化，以及取消上传任务的对象。

fail 回调的参数为 object，error 属性为错误码，errormessage 属性为错误消息。

my.downloadfile({
  url: 'https://img.alicdn.com/tfs/tb1x669sxxxxxbdafxxxxxxxxxx-520-280.jpg',
  success(res) {
    console.log('downloadfile success：',res.apfilepath,res.tempfilepath); // apfilepath 与 tempfilepath 等价
  },
  fail(res) {
    console.log('downloadfile fail：',res);
  },
});

my.downloadfile({
  url: 'https://alidata-pub.oss-cn-hangzhou.aliyuncs.com/test.pdf', // 请替换为有效的 url
  filepath: `${my.env.user_data_path}/my.pdf`, // 指定存储路径
  success(res) {
    console.log('downloadfile success：',res.filepath); // 指定 filepath 才有此字段，与传入的 filepath 相等
  },
  fail(res) {
    console.log('downloadfile fail：',res);
  },
});

let fs = my.getfilesystemmanager();
my.downloadfile({
  url: 'https://img.alicdn.com/tfs/tb1x669sxxxxxbdafxxxxxxxxxx-520-280.jpg',
  success(res) {
    const downpath = res.tempfilepath; // 下载后的路径，后缀名可能被篡改
    // 先通过 detectfiletype 获取真正后缀名
    my.detectfiletype({
      filepath: downpath,
      success(res) {
        console.log('真正的后缀名：',res.extension);
        // 保存文件，通过入参 filepath 修正路径
        fs.savefile({
          tempfilepath: downpath,
          filepath: `${my.env.user_data_path}/img${res.extension}`,
          success: (res1) => {
            console.log('被修正过的路径',res1.savedfilepath)
          }
        })
      }
    });
  }
});

my.downloadfile({
    url: 'https://...', // 需要下载的资源
    success(res) {
      // 如果是图片 可以预览
      // previewimage(res.tempfilepath);
      
      // 如果是 pdf 可以查看
      // opendocument(res.tempfilepath);
      
      // 如果是图片 可以保存相册
      // saveimagetophotosalbum(res.tempfilepath);
      
      // 如果是视频 可以保存相册
      // savevideotophotosalbum(res.tempfilepath);
    }
});
// 预览图片
function previewimage(path) {
  my.previewimage({
    urls: [ res.apfilepath ] 
  });
}
// 打开 pdf 文件
function opendocument(path) {
  my.opendocument({
    filetype: 'pdf',
    filepath: path
  });
}
// 保存图片到相册
function saveimagetophotosalbum(path) {
  my.saveimagetophotosalbum ({
    filepath: path,
    success (res) {
      console.log ('saveimagetophotosalbum 调用成功', res);
    }
  });
}
// 保存视频到相册
function savevideotophotosalbum(path) {
  my.savevideotophotosalbum ({
    filepath: path,
    success (res) {
      console.log ('savevideotophotosalbum 调用成功', res);
    }
  });
}

• tip

  只有当服务端状态码为 200，my.downloadfile 才会进入 success 回调。
• tip

  my.downloadfile 支持下载任何类型的文件。但图片类的后缀名可能会被篡改为 .image、视频类的后缀名可能被篡改为 .video，.docx/.excel等可能被改为 .other。可以通过 my.detectfiletype 获取文件真正的类型。可参考上文示例代码【代码示例->下载后将路径的后缀名转换为真实后缀名】
• tip

  my.downloadfile 下载后的文件路径可从出参 apfilepath 或 filepath 获取，两者均为内部虚拟路径，只能通过小程序的 api 访问。暂不支持保存文件到外部存储。具体可参考上文【代码示例->下载后如何应用】
• tip

  10.3.70 以前此接口有缓存，且缓存无法去除。10.3.70 版本去掉了此接口的缓存功能。
• bug

  支付宝 10.3.90 以下版本安卓端不支持 http 重定向，此时可能出现 ios 下载成功而 android 下载失败的情况
• tip

  下载接口没有文件大小的限制。filesystemmanager.savefile 保存文件接口有单个文件不能超过 30m、文件夹不能超过 200m 的限制。
• bug

  ios 端 10.5.10 以前，下载时指定的 filepath 若存在中文，会导致 my.opendocument 无法预览。此缺陷 10.5.10 已修复。
• bug

  ios 端支付宝 10.5.16 以下版本，my.downloadfile 可能会生成内部扩展名不正确的本地临时文件（可以使用小程序的文件 api 正常读取和操作，但通过 my.savefiletodisk 保存到系统存储空间后无法打开）。此缺陷已经在 10.5.16 版本修复。对于低版本的客户端，调用 downloadfile 时指定包含正确的扩展名的 filepath 入参可以规避此问题。