wx.addFileToFavorites(Object object)

基础库 2.16.1 开始支持,低版本需做兼容处理

Promise 风格 调用:支持

小程序插件:不支持

收藏文件

参数

Object object

属性 类型 默认值 必填 说明
filePath string 要收藏的文件地址,必须为本地路径或临时路径
fileName string 自定义文件名,若留空则使用filePath中的文件名
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

示例代码


  // callback 写法
  wx.downloadFile({
    url: URL, // 下载url
    success (res) {
      // 下载完成后收藏
      wx.addFileToFavorites({
        filePath: res.tempFilePath,
        success() {},
        fail: console.error,
      })
    },
    fail: console.error,
  })

  // async await 写法
  const { tempFilePath } = await wx.downloadFile({
    url: URL, // 下载url
  })
  // 下载完成后收藏
  await wx.addFileToFavorites({
    filePath: res.tempFilePath,
  })