微信小程序API 文件

2020-07-24 09:34 更新

wx.saveFile(OBJECT)


保存文件到本地。

OBJECT參數(shù)說明:

參數(shù)類型必填說明
tempFilePathString需要保存的文件的臨時(shí)路徑
successFunction返回文件的保存路徑,res = {savedFilePath: '文件的保存路徑'}
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

success返回參數(shù)說明:

參數(shù)說明
savedFilePath文件的保存路徑

示例代碼:

wx.chooseImage({
  success: function(res) {
    var tempFilePath = res.tempFilePath
    wx.saveFile({
      tempFilePath: tempFilePath[0],
      success: function(res) {
        var savedFilePath = res.savedFilePath
      }
    })
  }
})

bug & tip

  1. tip: 本地文件存儲(chǔ)的大小限制為 10M

wx.getFileInfo(OBJECT)

基礎(chǔ)庫(kù) 1.4.0 開始支持,低版本需做兼容處理

獲取文件信息

OBJECT參數(shù)說明:

參數(shù)名類型必填說明
filePathString本地文件路徑
digestAlgorithmString計(jì)算文件摘要的算法,默認(rèn)值 md5,有效值:md5,sha1
successFunction接口調(diào)用成功的回調(diào)函數(shù)
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

success返回參數(shù)說明:

參數(shù)名類型說明
sizeNumber文件大小,單位:B
digestString按照傳入的 digestAlgorithm 計(jì)算得出的的文件摘要
errMsgString調(diào)用結(jié)果

示例代碼:

wx.getFileInfo({
    success(res) {
        console.log(res.size)
        console.log(res.digest)
    }
})

wx.getSavedFileList(OBJECT)


獲取本地已保存的文件列表

OBJECT參數(shù)說明:

參數(shù)類型必填說明
successFunction接口調(diào)用成功的回調(diào)函數(shù),返回結(jié)果見success返回參數(shù)說明
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

success返回參數(shù)說明:

參數(shù)類型說明
errMsgString接口調(diào)用結(jié)果
fileListObject Array文件列表

fileList中的項(xiàng)目說明:

類型說明
filePathString文件的本地路徑
createTimeNumber文件的保存時(shí)的時(shí)間戳,從1970/01/01 08:00:00 到當(dāng)前時(shí)間的秒數(shù)
sizeNumber文件大小,單位B

示例代碼:

wx.getSavedFileList({
  success: function(res) {
    console.log(res.fileList)
  }
})

wx.getSavedFileInfo(OBJECT)

獲取本地文件的文件信息。此接口只能用于獲取已保存到本地的文件,若需要獲取臨時(shí)文件信息,請(qǐng)使用 wx.getFileInfo 接口。

OBJECT參數(shù)說明:

參數(shù)類型必填說明
filePathString文件路徑
successFunction接口調(diào)用成功的回調(diào)函數(shù),返回結(jié)果見success返回參數(shù)說明
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

success返回參數(shù)說明:

參數(shù)類型說明
errMsgString接口調(diào)用結(jié)果
sizeNumber文件大小,單位B
createTimeNumber文件的保存是的時(shí)間戳,從1970/01/01 08:00:00 到當(dāng)前時(shí)間的秒數(shù)

示例代碼:

wx.getSavedFileInfo({
  filePath: 'wxfile://somefile', //僅做示例用,非真正的文件路徑
  success: function(res) {
    console.log(res.size)
    console.log(res.createTime)
  }
})

wx.removeSavedFile(OBJECT)

刪除本地存儲(chǔ)的文件

OBJECT參數(shù)說明:

參數(shù)類型必填說明
filePathString需要?jiǎng)h除的文件路徑
successFunction接口調(diào)用成功的回調(diào)函數(shù)
failFunction接口調(diào)用失敗的回調(diào)函數(shù)
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行)

示例代碼:

wx.getSavedFileList({
  success: function(res) {
    if (res.fileList.length > 0){
      wx.removeSavedFile({
        filePath: res.fileList[0].filePath,
        complete: function(res) {
          console.log(res)
        }
      })
    }
  }
})

wx.openDocument(OBJECT)

新開頁(yè)面打開文檔,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx

OBJECT參數(shù)說明:

參數(shù)說明必填說明最低版本
filePathString文件路徑,可通過 downFile 獲得 
fileTypeString文件類型,指定文件類型打開文件,有效值 doc, xls, ppt, pdf, docx, xlsx, pptx1.4.0
successFunction接口調(diào)用成功的回調(diào)函數(shù) 
failFunction接口調(diào)用失敗的回調(diào)函數(shù) 
completeFunction接口調(diào)用結(jié)束的回調(diào)函數(shù)(調(diào)用成功、失敗都會(huì)執(zhí)行) 

示例代碼

wx.downloadFile({  url: 'http://example.com/somefile.pdf',
  success: function (res) {
    var filePath = res.tempFilePath 
    wx.openDocument({
      filePath: filePath,
      success: function (res) {
        console.log('打開文檔成功')
      }
    })
  }
})
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)