阅读(3969) (10)

百度智能小程序API 文件

2018-07-09 17:01:32 更新

saveFile


解释: 保存文件到本地

参数: Object

注意: saveFile 会把临时文件移动,因此调用成功后传入的 tempFilePath 将不可用。

Object参数说明:

参数名 类型 必填 说明
tempFilePath String 需要保存的文件的临时路径
success Function 返回文件的保存路径,res = {savedFilePath: ‘文件的保存路径’}
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名 类型 说明
savedFilePath String 文件的保存路径

示例:

swan.chooseImage({
    count: '1'
    success: function (res) {
        var tempFilePaths = res.tempFilePaths;
        swan.saveFile({
            tempFilePath: tempFilePaths[0],
            success: function (res) {
                var savedFilePath = res.savedFilePath;
            }
        });
    }
});

getFileInfo


解释: 获取文件信息

参数:Object

Object参数说明:

参数名 类型 必填 说明
filePath String 本地文件路径
digestAlgorithm String 计算文件摘要的算法,默认值 md5,有效值:md5,sha1
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名 类型 说明
size Number 文件大小,单位:B
digest String 按照传入的 digestAlgorithm 计算得出的的文件摘要
errMsg Number 调用结果

示例:

swan.getFileInfo({
    filePath: '/test/test.txt',
    success: function (res) {
        console.log(res.size);
        console.log(res.digest);
        console.log(res.errMsg); //调用结果
    }
});

getSavedFileList


解释:获取本地已保存的文件列表参数:Object

Object参数说明:

参数名 类型 必填 说明
success Function 接口调用成功的回调函数,返回结果见success返回参数说明
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名 类型 说明
fileList Object Array 文件列表

fileList中的项目说明:

参数名 类型 说明
filePath String 文件的本地路径
createTime Number 文件的保存时的时间戳,从1970/01/01 08:00:00 到当前时间的秒数
size Number 文件大小,单位 B

示例:

swan.getSavedFileList({
    success: function (res) {
        var fileList = res.fileList;
    }
});

getSavedFileInfo


解释: 获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 getFileInfo 接口

参数: Object

Object参数说明:

参数名 类型 必填 说明
filePath String 文件路径
success Function 接口调用成功的回调函数,返回结果见 success 返回参数说明
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success返回参数说明:

参数名 类型 说明
size Number 文件大小,单位B
createTime Number 文件保存时的时间戳,从1970/01/01 08:00:00 到该时刻的秒数

示例:

swan.getSavedFileInfo({
    filePath: 'bdfile://somefile',
    success: function (res) {
        console.log(res.size);
        console.log(res.createTime);
    },
    fail: function (err) {
        console.log('错误码:' + err.errCode);
        console.log('错误信息:' + err.errMsg);
    }
});

removeSavedFile


解释: 删除本地存储的文件

参数: Object

Object参数说明:

参数名 类型 必填 说明
filePath String 需要删除的文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

示例:

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

openDocument


解释: 新开页面打开文档,支持格式:doc, xls, ppt, pdf, docx, xlsx, pptx

参数: Object

Object参数说明:

参数名 类型 必填 说明
filePath String 文件路径,可通过 downloadFile 获得
fileType String 文件类型,指定文件类型打开文件,有效值 doc, xls, ppt, pdf, docx, xlsx, pptx
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

示例:

swan.downloadFile({
    url: 'http://example.com/somefile.pdf',
    success: function (res) {
        var filePath = res.tempFilePath;
        swan.openDocument({
            filePath: filePath,
            success: function (res) {
                console.log('打开文档成功');
            }
        });
    }
});
Tips: bdfile:// 开头的文件均不能预览