# API 指引

# 上传文件

在小程序端可调用 wx.cloud.uploadFile 方法进行上传：

  1. wx.cloud.uploadFile({
  2.   cloudPath: 'example.png', // 上传至云端的路径
  3.   filePath: '', // 小程序临时文件路径
  4.   success: res => {
  5.     // 返回文件 ID
  6.     console.log(res.fileID)
  7.   },
  8.   fail: console.error
  9. })

上传成功后会获得文件唯一标识符，即文件 ID，后续操作都基于文件 ID 而不是 URL。

# 下载文件

可以根据文件 ID 下载文件，用户仅可下载其有访问权限的文件：

  1. wx.cloud.downloadFile({
  2.   fileID: '', // 文件 ID
  3.   success: res => {
  4.     // 返回临时文件路径
  5.     console.log(res.tempFilePath)
  6.   },
  7.   fail: console.error
  8. })

# 删除文件

可以通过 wx.cloud.deleteFile 删除文件：

  1. wx.cloud.deleteFile({
  2.   fileList: ['a7xzcb'],
  3.   success: res => {
  4.     // handle success
  5.     console.log(res.fileList)
  6.   },
  7.   fail: console.error
  8. })

更详细的 API 可参考小程序端及后端存储 API 文件。

# 组件支持

支持在 image、audio 等组件中传入云文件 ID

# 换取临时链接

可以根据文件 ID 换取临时文件网络链接，文件链接有有效期为两个小时：

  1. wx.cloud.getTempFileURL({
  2.   fileList: ['cloud://xxx.png'],
  3.   success: res => {
  4.     // fileList 是一个有如下结构的对象数组
  5.     // [{
  6.     //    fileID: 'cloud://xxx.png', // 文件 ID
  7.     //    tempFileURL: '', // 临时文件网络链接
  8.     //    maxAge: 120 * 60 * 1000, // 有效期
  9.     // }]
  10.     console.log(res.fileList)
  11.   },
  12.   fail: console.error
  13. })

# API 文档

可以在此参考详细的API 文档：