文件

qh.saveFile

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

方法参数:Object object

object参数说明

参数名类型必填默认值说明
tempFilePathString-需要保存的文件的临时路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
savedFilePath存储后的文件路径

qh.removeSavedFile

解释:删除本地缓存文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-需要删除的文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

qh.openDocument

解释:新开页面打开文档,不能打开临时文件,需要先使用saveFile将临时文件保存后,才能打开

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-文件路径,可通过 downloadFile 获得
fileTypeString-文件类型,指定文件类型打开文件
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

object.fileType 的合法值

说明
docdoc格式
docxdocx格式
xlsxls格式
xlsxxlsx格式
pptppt格式
pptxpptx格式
pdfpdf格式

qh.getSavedFileList

解释:获取该小程序下已保存的本地缓存文件列表

方法参数:Object object

object参数说明

参数名类型必填默认值说明
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
fileList文件数组,每一项是一个 FileItem

qh.getSavedFileInfo

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

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
size文件大小,单位 B
createTime文件保存时的时间戳

qh.getFileInfo

解释:获取文件信息

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-本地文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
size文件大小,以字节为单位

qh.getFileSystemManager

解释:获取全局唯一的文件管理器

返回值 FileSystemManager

FileSystemManager.access

解释:判断文件/目录是否存在

方法参数:Object object

object参数说明

参数名类型必填默认值说明
pathString-要判断是否存在的文件/目录路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.accessSync

解释:FileSystemManager.access 的同步版本

方法参数

string path: 要判断是否存在的文件/目录路径

FileSystemManager.appendFile

解释:在文件结尾追加内容

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-要追加内容的文件路径
datastring-要追加的文本
encodingstringutf8指定写入文件的字符编码
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

object.encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8

FileSystemManager.appendFileSync

解释:FileSystemManager.appendFile 的同步版本

方法参数

string filePath: 要追加内容的文件路径

string data: 要追加的文本

string encoding: 指定写入文件的字符编码

encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8

FileSystemManager.copyFile

解释:复制文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
srcPathString-源文件路径,只可以是普通文件
destPathString-目标文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.copyFileSync

解释:FileSystemManager.copyFile 的同步版本

方法参数

string srcPath: 源文件路径,只可以是普通文件

string destPath: 目标文件路径

FileSystemManager.getFileInfo

解释: 获取该小程序下的 本地临时文件 或 本地缓存文件 信息

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-要读取的文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
size文件大小,以字节为单位

FileSystemManager.getSavedFileList

解释:获取该小程序下已保存的本地缓存文件列表

方法参数:Object object

object参数说明

参数名类型必填默认值说明
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
fileList文件数组

FileSystemManager.mkdir

解释:创建目录

方法参数:Object object

object参数说明

参数名类型必填默认值说明
dirPathString-创建的目录路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.mkdirSync

解释:FileSystemManager.mkdir 的同步版本

方法参数

string dirPath: 创建的目录路径

FileSystemManager.readdir

解释:读取目录内文件列表

方法参数:Object object

object参数说明

参数名类型必填默认值说明
dirPathString-要读取的目录路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
files指定目录下的文件数组。

FileSystemManager.readdirSync

解释:FileSystemManager.readdir 的同步版本

方法参数

string dirPath: 要读取的目录路径

返回值

array files: 指定目录下的文件数组

FileSystemManager.readFile

解释:读取本地文件内容

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-要读取的文件的路径
encodingString-指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

object.encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8

success 返回参数说明

参数说明
data文件内容

FileSystemManager.readFileSync

解释:FileSystemManager.readFile 的同步版本

方法参数

string filePath: 要读取的目录路径

string encoding: 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容

encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8

返回值

string data: 文件内容

FileSystemManager.removeSavedFile

解释:删除该小程序下已保存的本地缓存文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-需要删除的文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.rename

解释:重命名文件。可以把文件从 oldPath 移动到 newPath

方法参数:Object object

object参数说明

参数名类型必填默认值说明
oldPathString-源文件路径,可以是普通文件或目录
newPathString-新文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.renameSync

解释:FileSystemManager.rename 的同步版本

方法参数

string oldPath: 源文件路径,可以是普通文件或目录

string newPath: 新文件路径

FileSystemManager.rmdir

解释:删除目录

方法参数:Object object

object参数说明

参数名类型必填默认值说明
dirPathString-要删除的目录路径
recursiveBooleanfalse是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.rmdirSync

解释:FileSystemManager.rmdir 的同步版本

方法参数

string dirPath: 要删除的目录路径

boolean recursive: 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。

FileSystemManager.saveFile

解释:保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。

方法参数:Object object

object参数说明

参数名类型必填默认值说明
tempFilePathString-临时存储文件路径
filePathString-要存储的文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
savedFilePath存储后的文件路径

FileSystemManager.saveFileSync

解释:FileSystemManager.saveFile 的同步版本

方法参数

string tempFilePath: 临时存储文件路径

string filePath: 要存储的文件路径

返回值

string savedFilePath: 存储后的文件路径

FileSystemManager.stat

解释:获取文件 Stats 对象

方法参数:Object object

object参数说明

参数名类型必填默认值说明
pathString-文件/目录路径
recursiveBooleanfalse是否递归获取目录下的每个文件的 Stats 信息
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数说明
stats

FileSystemManager.statSync

解释:FileSystemManager.stat 的同步版本

方法参数

string path: 文件/目录路径

boolean recursive: 是否递归获取目录下的每个文件的 Stats 信息

返回值

Object stats:当 recursive 为 false 时,res.stats 是一个 Stats 对象。当 recursive 为 true 且 path 是一个目录的路径时,res.stats 是一个 Object,key 以 path 为根路径的相对路径,value 是该路径对应的 Stats 对象。

FileSystemManager.unlink

解释:删除文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-要删除的文件路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.unlinkSync

解释:FileSystemManager.unlink 的同步版本

方法参数

string filePath: 要删除的文件路径

FileSystemManager.unzip

解释:解压文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
zipFilePathString-源文件路径,只可以是 zip 压缩文件
targetPathString-目标目录路径
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

FileSystemManager.writeFile

解释:写文件

方法参数:Object object

object参数说明

参数名类型必填默认值说明
filePathString-要写入的文件路径
dataString-要写入的文本
encodingStringutf8指定写入文件的字符编码
successFunction-接口调用成功的回调函数
failFunction-接口调用失败的回调函数
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)

object.encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8

FileSystemManager.writeFileSync

解释:FileSystemManager.writeFile 的同步版本

方法参数

string filePath: 要写入的文件路径

string data: 要写入的文本

string encoding: 指定写入文件的字符编码

encoding 的合法值

说明
base64base64
utf-8utf-8
utf8utf8