調用my.saveFile儲存檔案到本地 - Mobile Platform as a Service

my.saveFile

說明

基礎庫 1.13.0 及以上版本支援該介面，低版本需做相容處理，操作參見小程式基礎庫說明。mPaaS 10.1.32 及以上版本支援該介面。

該介面用於儲存檔案到本地（本地檔案大小總容量限制：10M）。調用 my.saveFile 成功後，安卓系統可在手機儲存 /alipay/pictures/ 檔案位置查看儲存的檔案；iOS 系統無法查看被隱藏的目錄路徑。

入參

名稱	類型	必填	描述
apFilePath	String	是	檔案路徑
success	Function	否	調用成功的回呼函數
fail	Function	否	調用失敗的回呼函數
complete	Function	否	調用結束的回呼函數（調用成功、失敗都會執行）

success 傳回值說明

名稱	類型	描述
apFilePath	String	檔案儲存路徑

程式碼範例

my.chooseImage({
  success: (res) => {
    my.saveFile({
      apFilePath: res.apFilePaths[0],
      success: (res) => {
        console.log(JSON.stringify(res))
      },
    });
  },
});

my.getFileInfo

說明

基礎庫 1.4.0 及以上版本支援該介面，低版本需做相容處理，操作參見小程式基礎庫說明。mPaaS 10.1.32 及以上版本支援該介面。

入參說明

名稱	類型	必填	描述
apFilePath	String	是	檔案路徑（本地路徑）
digestAlgorithm	String	否	摘要演算法，支援 `md5` 和 `sha1` ，預設為 `md5`
success	Function	否	調用成功的回呼函數
fail	Function	否	調用失敗的回呼函數
complete	Function	否	調用結束的回呼函數（調用成功、失敗都會執行）

success 傳回值說明

名稱	類型	描述
size	Number	檔案大小
digest	String	摘要結果

程式碼範例

my.getFileInfo({
    apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
    digestAlgorithm:'sha1',
    success:(res)=>{
        console.log(JSON.stringify(res))
    }
})

my.getSavedFileInfo

說明

基礎庫 1.3.0 及以上版本支援該介面，低版本需做相容處理，操作參見小程式基礎庫說明。mPaaS 10.1.32 及以上版本支援該介面。

該介面用於擷取儲存的檔案資訊。

入參

名稱	類型	必填	描述
apFilePath	String	是	檔案路徑
success	Function	否	調用成功的回呼函數
fail	Function	否	調用失敗的回呼函數
complete	Function	否	調用結束的回呼函數（調用成功、失敗都會執行）

success 傳回值說明

名稱	類型	描述
size	Number	檔案大小
createTime	Number	建立時間的時間戳記

程式碼範例

使用 my.saveFile 儲存的地址才能夠使用 my.getSavedFileInfo。

var that = this;
    my.chooseImage({
    success: (res) => {
      console.log(res.apFilePaths[0], 1212)
      my.saveFile({
        apFilePath: res.apFilePaths[0],
        success: (result) => {
          console.log(result, 1212)
          my.getSavedFileInfo({
            apFilePath: result.apFilePath,
            success: (resu) => {
              console.log(JSON.stringify(resu))
              that.filePath = resu
            }
          })
        },
      });
    },
});

my.getSavedFileList

說明

基礎庫 1.13.0 及以上版本支援該介面，低版本需做相容處理，操作參見小程式基礎庫說明。mPaaS 10.1.32 及以上版本支援該介面。

該介面用於擷取儲存的所有檔案。

入參

名稱	類型	必填	描述
success	Function	否	調用成功的回呼函數
fail	Function	否	調用失敗的回呼函數
complete	Function	否	調用結束的回呼函數（調用成功、失敗都會執行）

success 傳回值說明

名稱	類型	描述
fileList	List	檔案清單

File 對象屬性說明

名稱	類型	描述
size	Number	檔案大小
createTime	Number	建立時間
apFilePath	String	檔案路徑

程式碼範例

my.getSavedFileList({
    success:(res)=>{
        console.log(JSON.stringfy(res))
    }
});

my.removeSavedFile

說明

基礎庫 1.13.0 及以上版本支援該介面，低版本需做相容處理，操作參見小程式基礎庫說明。mPaaS 10.1.32 及以上版本支援該介面。

該介面用於刪除某個儲存的檔案。

入參

名稱	類型	必填	描述
apFilePath	String	是	檔案路徑
success	Function	否	調用成功的回呼函數
fail	Function	否	調用失敗的回呼函數
complete	Function	否	調用結束的回呼函數（調用成功、失敗都會執行）

程式碼範例

my.getSavedFileList({
        success:(res)=>{
            my.removeSavedFile({
          apFilePath:res.fileList[0].apFilePath,
          success:(res)=>{
            console.log('remove success')
          }
        })
        }
    });

my.openDocument

my.openDocument(Object object)

預覽本地 PDF 檔案。

入參

Object object

屬性	類型	預設值	必填	相容性	描述
filePath	String	-	是	-	檔案路徑（本地臨時檔案、本機快取檔案、本機使用者檔案）。
fileType	String	-	是	-	檔案類型。可選值：pdf。
success	Function	-	否	-	調用成功的回呼函數。
fail	Function	-	否	-	調用失敗的回呼函數。
complete	Function	-	否	-	調用結束的回呼函數。說明調用成功、失敗都會執行。

錯誤碼

fail 回調的參數為 Object，error 屬性為錯誤碼，errorMessage 屬性為錯誤訊息。

錯誤碼	錯誤訊息	解決方案
4011	路徑不合法	檢查傳入的檔案路徑 filePath 是否正確，可參考入參 filePath 的類型和描述。
4012	檔案不存在	請檢查傳入 filePath 對應的檔案是否存在。
4013	暫不支援此檔案類型	請檢查傳入的 fileType 是否正確，可參考入參 fileType 的描述。

程式碼範例

my.openDocument({
  filePath: `${my.env.USER_DATA_PATH}/test.pdf`,
  fileType: 'pdf',
  success: (res) => {
    console.log(res);
  },
  fail: (err) => {
    console.log(err);
  },
});

提示

通過 my.downloadFile 下載 PDF ，擷取本地臨時檔案路徑作為 filePath 參數。