支付宝小程序API 文件
my.getFileInfo
简介
my.getFileInfo 是获取文件信息的 API。
使用限制
基础库 1.4.0 或更高版本,若版本较低,建议采取 兼容处理。
扫码体验
效果示例
示例代码
// .js
my.getFileInfo({
apFilePath:'https://resource/apml953bb093ebd2834530196f50a4413a87.video',
digestAlgorithm:'sha1',
success:(res)=>{
console.log(JSON.stringify(res))
}
})
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
apFilePath | String | 是 | 文件路径(本地路径)。 |
digestAlgorithm | String | 否 | 摘要算法,支持 md5 和 sha1,默认为 md5。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
属性 | 类型 | 描述 |
---|---|---|
size | Number | 文件大小。 |
digest | String | 摘要结果。 |
my.getSavedFileInfo
简介
my.getSavedFileInfo 是获取保存的文件信息的 API。
使用限制
基础库 1.3.0 或更高版本,若版本较低,建议采取 兼容处理。
扫码体验
效果示例
示例代码
使用 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
}
})
},
});
},
});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
apFilePath | String | 是 | 文件路径。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
属性 | 类型 | 描述 |
---|---|---|
size | Number | 文件大小。 |
createTime | Number | 创建时间的时间戳。 |
my.getSavedFileList
简介
my.getSavedFileList 是获取保存的所有文件信息的 API。
使用限制
基础库 1.13.0 或更高版本;支付宝客户端 10.1.32 或更高版本,若版本较低,建议采取 兼容处理。
扫码体验
效果示例
示例代码
// .js
my.getSavedFileList({
success:(res)=>{
console.log(JSON.stringify(res))
}
});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
属性 | 类型 | 描述 |
---|---|---|
fileList | List | 文件列表。 |
File 对象属性
属性 | 类型 | 描述 |
---|---|---|
size | Number | 文件大小。 |
createTime | Number | 创建时间。 |
apFilePath | String | 文件路径。 |
my.openDocument
简介
my.openDocument 是在新页面打开文件预览的 API,暂时只支持预览 PDF 格式文件。
使用限制
- 基础库 1.15.0 或更高版本,支付宝客户端 10.1.60 或更高版本,若版本较低,建议采取 兼容处理。
- my.openDocument 只支持在真机上测试,无法在 IDE 上调试。
示例代码
// .js
my.downloadFile({
// 示例 url,并非真实存在
url: 'http://documentExample.com/alipay.pdf',
success({ apFilePath }) {
my.hideLoading();
my.openDocument({
filePath: apFilePath,
fileType: 'pdf',
success: (res) => {
console.log('open document success')
}
})
}
})
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
filePath | String | 是 | 文件路径,可通过 my.downloadFile获得。 |
fileType | String | 否 | 文件类型。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
fileType 合法值
值 | 说明 |
---|---|
PDF 格式。 |
错误码
错误码 | 描述 | 解决方案 |
---|---|---|
4011 | 无效的文件路径,或者传入路径没有权限访问。 | 检查传入的文件路径。 |
4012 | 预览文件不存在。 | 确保文件路径对应的文件存在。 |
4013 | 文件类型暂不支持。 | 目前暂仅支持 PDF 文件格式的预览 。 |
my.removeSavedFile
简介
my.removeSavedFile 是删除某个保存的文件的 API。
使用限制
基础库 1.13.0 或更高版本,支付宝客户端 10.1.32 或更高版本,若版本较低,建议采取 兼容处理。
扫码体验
效果示例
示例代码
// .js
my.getSavedFileList({
success:(res)=>{
my.removeSavedFile({
apFilePath:res.fileList[0].apFilePath,
success:(res)=>{
console.log('remove success')
}
})
}
});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
apFilePath | String | 是 | 文件路径。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
my.saveFile
简介
my.saveFile 是保存文件到本地(本地文件大小总容量限制:10 MB)的 API。
调用 my.saveFile 成功后,安卓系统可在 手机存储/alipay/pictures/文件位置 查看保存的文件;iOS 系统无法查看被隐藏的目录路径。
使用限制
基础库 1.13.0 或更高版本,支付宝客户端 10.1.32 或更高版本,若版本较低,建议采取 兼容处理。
扫码体验
效果示例
示例代码
// .js
my.chooseImage({
success: (res) => {
my.saveFile({
apFilePath: res.apFilePaths[0],
success: (res) => {
console.log(JSON.stringify(res))
},
});
},
});
入参
Object 类型,属性如下:
属性 | 类型 | 必填 | 描述 |
---|---|---|---|
apFilePath | String | 是 | 文件路径。 |
success | Function | 否 | 调用成功的回调函数。 |
fail | Function | 否 | 调用失败的回调函数。 |
complete | Function | 否 | 调用结束的回调函数(调用成功、失败都会执行)。 |
success 回调函数
属性 | 类型 | 描述 |
---|---|---|
apFilePath | String | 文件保存路径。 |
更多建议: