- 文件
- qh.saveFile
- qh.removeSavedFile
- qh.openDocument
- qh.getSavedFileList
- qh.getSavedFileInfo
- qh.getFileInfo
- qh.getFileSystemManager
- FileSystemManager.access
- FileSystemManager.accessSync
- FileSystemManager.appendFile
- FileSystemManager.appendFileSync
- FileSystemManager.copyFile
- FileSystemManager.copyFileSync
- FileSystemManager.getFileInfo
- FileSystemManager.getSavedFileList
- FileSystemManager.mkdir
- FileSystemManager.mkdirSync
- FileSystemManager.readdir
- FileSystemManager.readdirSync
- FileSystemManager.readFile
- FileSystemManager.readFileSync
- FileSystemManager.removeSavedFile
- FileSystemManager.rename
- FileSystemManager.renameSync
- FileSystemManager.rmdir
- FileSystemManager.rmdirSync
- FileSystemManager.saveFile
- FileSystemManager.saveFileSync
- FileSystemManager.stat
- FileSystemManager.statSync
- FileSystemManager.unlink
- FileSystemManager.unlinkSync
- FileSystemManager.unzip
- FileSystemManager.writeFile
- FileSystemManager.writeFileSync
文件
qh.saveFile
解释:保存文件到本地。注意:saveFile 会把临时文件移动,因此调用成功后传入的 tempFilePath 将不可用
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
tempFilePath | String | 是 | - | 需要保存的文件的临时路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
savedFilePath | 存储后的文件路径 |
qh.removeSavedFile
解释:删除本地缓存文件
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 需要删除的文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
qh.openDocument
解释:新开页面打开文档,不能打开临时文件,需要先使用saveFile将临时文件保存后,才能打开
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 文件路径,可通过 downloadFile 获得 |
fileType | String | 是 | - | 文件类型,指定文件类型打开文件 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.fileType 的合法值:
值 | 说明 |
---|---|
doc | doc格式 |
docx | docx格式 |
xls | xls格式 |
xlsx | xlsx格式 |
ppt | ppt格式 |
pptx | pptx格式 |
pdf格式 |
qh.getSavedFileList
解释:获取该小程序下已保存的本地缓存文件列表
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
fileList | 文件数组,每一项是一个 FileItem |
qh.getSavedFileInfo
解释:获取本地文件的文件信息。此接口只能用于获取已保存到本地的文件,若需要获取临时文件信息,请使用 wx.getFileInfo() 接口。
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
size | 文件大小,单位 B |
createTime | 文件保存时的时间戳 |
qh.getFileInfo
解释:获取文件信息
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 本地文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
size | 文件大小,以字节为单位 |
qh.getFileSystemManager
解释:获取全局唯一的文件管理器
返回值 FileSystemManager
FileSystemManager.access
解释:判断文件/目录是否存在
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
path | String | 是 | - | 要判断是否存在的文件/目录路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.accessSync
解释:FileSystemManager.access 的同步版本
方法参数
string path: 要判断是否存在的文件/目录路径
FileSystemManager.appendFile
解释:在文件结尾追加内容
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 要追加内容的文件路径 |
data | string | 是 | - | 要追加的文本 |
encoding | string | 否 | utf8 | 指定写入文件的字符编码 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |
FileSystemManager.appendFileSync
解释:FileSystemManager.appendFile 的同步版本
方法参数
string filePath: 要追加内容的文件路径
string data: 要追加的文本
string encoding: 指定写入文件的字符编码
encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |
FileSystemManager.copyFile
解释:复制文件
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
srcPath | String | 是 | - | 源文件路径,只可以是普通文件 |
destPath | String | 是 | - | 目标文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.copyFileSync
解释:FileSystemManager.copyFile 的同步版本
方法参数
string srcPath: 源文件路径,只可以是普通文件
string destPath: 目标文件路径
FileSystemManager.getFileInfo
解释: 获取该小程序下的 本地临时文件 或 本地缓存文件 信息
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 要读取的文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
size | 文件大小,以字节为单位 |
FileSystemManager.getSavedFileList
解释:获取该小程序下已保存的本地缓存文件列表
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
fileList | 文件数组 |
FileSystemManager.mkdir
解释:创建目录
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
dirPath | String | 是 | - | 创建的目录路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.mkdirSync
解释:FileSystemManager.mkdir 的同步版本
方法参数
string dirPath: 创建的目录路径
FileSystemManager.readdir
解释:读取目录内文件列表
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
dirPath | String | 是 | - | 要读取的目录路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
files | 指定目录下的文件数组。 |
FileSystemManager.readdirSync
解释:FileSystemManager.readdir 的同步版本
方法参数
string dirPath: 要读取的目录路径
返回值
array files: 指定目录下的文件数组
FileSystemManager.readFile
解释:读取本地文件内容
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 要读取的文件的路径 |
encoding | String | 否 | - | 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |
success 返回参数说明:
参数 | 说明 |
---|---|
data | 文件内容 |
FileSystemManager.readFileSync
解释:FileSystemManager.readFile 的同步版本
方法参数
string filePath: 要读取的目录路径
string encoding: 指定读取文件的字符编码,如果不传 encoding,则以 ArrayBuffer 格式读取文件的二进制内容
encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |
返回值
string data: 文件内容
FileSystemManager.removeSavedFile
解释:删除该小程序下已保存的本地缓存文件
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 需要删除的文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.rename
解释:重命名文件。可以把文件从 oldPath 移动到 newPath
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
oldPath | String | 是 | - | 源文件路径,可以是普通文件或目录 |
newPath | String | 是 | - | 新文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.renameSync
解释:FileSystemManager.rename 的同步版本
方法参数
string oldPath: 源文件路径,可以是普通文件或目录
string newPath: 新文件路径
FileSystemManager.rmdir
解释:删除目录
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
dirPath | String | 是 | - | 要删除的目录路径 |
recursive | Boolean | 否 | false | 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.rmdirSync
解释:FileSystemManager.rmdir 的同步版本
方法参数
string dirPath: 要删除的目录路径
boolean recursive: 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
FileSystemManager.saveFile
解释:保存临时文件到本地。此接口会移动临时文件,因此调用成功后,tempFilePath 将不可用。
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
tempFilePath | String | 是 | - | 临时存储文件路径 |
filePath | String | 否 | - | 要存储的文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
success 返回参数说明:
参数 | 说明 |
---|---|
savedFilePath | 存储后的文件路径 |
FileSystemManager.saveFileSync
解释:FileSystemManager.saveFile 的同步版本
方法参数
string tempFilePath: 临时存储文件路径
string filePath: 要存储的文件路径
返回值
string savedFilePath: 存储后的文件路径
FileSystemManager.stat
解释:获取文件 Stats 对象
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
path | String | 是 | - | 文件/目录路径 |
recursive | Boolean | 否 | false | 是否递归获取目录下的每个文件的 Stats 信息 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
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
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 要删除的文件路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.unlinkSync
解释:FileSystemManager.unlink 的同步版本
方法参数
string filePath: 要删除的文件路径
FileSystemManager.unzip
解释:解压文件
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
zipFilePath | String | 是 | - | 源文件路径,只可以是 zip 压缩文件 |
targetPath | String | 是 | - | 目标目录路径 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
FileSystemManager.writeFile
解释:写文件
方法参数:Object object
object
参数说明:
参数名 | 类型 | 必填 | 默认值 | 说明 |
---|---|---|---|---|
filePath | String | 是 | - | 要写入的文件路径 |
data | String | 是 | - | 要写入的文本 |
encoding | String | 否 | utf8 | 指定写入文件的字符编码 |
success | Function | 否 | - | 接口调用成功的回调函数 |
fail | Function | 否 | - | 接口调用失败的回调函数 |
complete | Function | 否 | - | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |
FileSystemManager.writeFileSync
解释:FileSystemManager.writeFile 的同步版本
方法参数
string filePath: 要写入的文件路径
string data: 要写入的文本
string encoding: 指定写入文件的字符编码
encoding 的合法值:
值 | 说明 |
---|---|
base64 | base64 |
utf-8 | utf-8 |
utf8 | utf8 |