支付寶小程序API 文件

my.getFileInfo

簡(jiǎn)介

my.getFileInfo 是獲取文件信息的 API。

使用限制

基礎(chǔ)庫 1.4.0 或更高版本，若版本較低，建議采取 兼容處理。

掃碼體驗(yàn)

效果示例

示例代碼

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

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
apFilePath	String	是	文件路徑（本地路徑）。
digestAlgorithm	String	否	摘要算法，支持 md5 和 sha1，默認(rèn)為 md5。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)

my.getSavedFileInfo

簡(jiǎn)介

my.getSavedFileInfo 是獲取保存的文件信息的 API。

使用限制

基礎(chǔ)庫 1.3.0 或更高版本，若版本較低，建議采取 兼容處理。

掃碼體驗(yàn)

效果示例

示例代碼

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

// .js
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
            }
          })
        },
      });
    },
});

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
apFilePath	String	是	文件路徑。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)

my.getSavedFileList

簡(jiǎn)介

my.getSavedFileList 是獲取保存的所有文件信息的 API。

使用限制

基礎(chǔ)庫 1.13.0 或更高版本；支付寶客戶端 10.1.32 或更高版本，若版本較低，建議采取 兼容處理。

掃碼體驗(yàn)

效果示例

示例代碼

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

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)

File 對(duì)象屬性

my.openDocument

簡(jiǎn)介

my.openDocument 是在新頁面打開文件預(yù)覽的 API，暫時(shí)只支持預(yù)覽 PDF 格式文件。

使用限制

• 基礎(chǔ)庫 1.15.0 或更高版本，支付寶客戶端 10.1.60 或更高版本，若版本較低，建議采取 兼容處理。
• my.openDocument 只支持在真機(jī)上測(cè)試，無法在 IDE 上調(diào)試。

示例代碼

// .js


my.downloadFile({
  // 示例 url，并非真實(shí)存在
      url: 'http://documentExample.com/alipay.pdf',
      success({ apFilePath }) {
        my.hideLoading();
        my.openDocument({
          filePath: apFilePath,
          fileType: 'pdf',
          success: (res) => {
            console.log('open document success')
            }
          })
        }
      })

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
filePath	String	是	文件路徑，可通過 my.downloadFile獲得。
fileType	String	否	文件類型。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

fileType 合法值

錯(cuò)誤碼

my.removeSavedFile

簡(jiǎn)介

my.removeSavedFile 是刪除某個(gè)保存的文件的 API。

使用限制

基礎(chǔ)庫 1.13.0 或更高版本，支付寶客戶端 10.1.32 或更高版本，若版本較低，建議采取 兼容處理。

掃碼體驗(yàn)

效果示例

示例代碼

// .js


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

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
apFilePath	String	是	文件路徑。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

my.saveFile

簡(jiǎn)介

my.saveFile 是保存文件到本地（本地文件大小總?cè)萘肯拗疲?0 MB）的 API。

調(diào)用 my.saveFile 成功后，安卓系統(tǒng)可在 手機(jī)存儲(chǔ)/alipay/pictures/文件位置 查看保存的文件；iOS 系統(tǒng)無法查看被隱藏的目錄路徑。

使用限制

基礎(chǔ)庫 1.13.0 或更高版本，支付寶客戶端 10.1.32 或更高版本，若版本較低，建議采取 兼容處理。

掃碼體驗(yàn)

效果示例

示例代碼

// .js


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

入?yún)?/h4>

Object 類型，屬性如下：

屬性	類型	必填	描述
apFilePath	String	是	文件路徑。
success	Function	否	調(diào)用成功的回調(diào)函數(shù)。
fail	Function	否	調(diào)用失敗的回調(diào)函數(shù)。
complete	Function	否	調(diào)用結(jié)束的回調(diào)函數(shù)（調(diào)用成功、失敗都會(huì)執(zhí)行）。

success 回調(diào)函數(shù)