FileManager

此文档提供了文件管理的API。

:仅支持操作/mnt/sd0/filesystem路径下的文件

引入方式:

var file = pm.getFileSystemManager();

返回 Object类型文件管理器。

access(Object object)

判断文件/目录是否存在。

参数 Object object

属性 类型 描述
path String 要判断是否存在的文件/目录路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.access({ path: "test.txt",
              success: function ()  { console.log("success");  },
              fail: function (res)  { console.dir(res.errMsg); },
              complete: function () { console.log("complete"); }
            });

file.access({ path: "test/demo",
              success: function ()  { console.log("success");  },
              fail: function (res)  { console.dir(res.errMsg); },
              complete: function () { console.log("complete"); }
            });

appendFile(Object object)

在文件结尾追加内容,如果文件不存在则创建该文件。

参数 Object object

属性 类型 描述
filePath String 要追加内容的文件路径
data String/Buffer 要追加的数据
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.appendFile({ filePath: "test.txt",
                  data: "test.txt",
                  success: function ()  { console.log("success");  },
                  fail: function (res)  { console.dir(res.errMsg); },
                  complete: function () { console.log("complete"); }
                });

getFileList(Object object)

获取已保存的本地文件列表。

参数 Object object

属性 类型 描述
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性 类型 描述
fileList Array.Object 文件数组

fileList Object

属性 类型 描述
filePath String 路径
size Number 文件大小,以字节为单位

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.getFileList({ success: function (res) { console.dir(res.fileList);},
                        fail: function (res){ console.dir(res.errMsg);  },
                        complete: function ()   { console.log("complete");}
                    });

removeFile(Object object)

删除文件。功能与 unlink 类似。

参数 Object object

属性 类型 描述
filePath String 要删除临时文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.removeFile({ filePath: "demo.txt",
                       success: function () { console.log("success"); },
                       fail: function (res) { console.dir(res.errMsg); },
                       complete: function () { console.log("complete"); }
                    });

copyFile(Object object)

复制文件。如果目标文件存在,且内容多余源文件,则覆盖源文件内容长度的内容。

参数 Object object

属性 类型 描述
srcPath String 源文件路径
destPath String 目标文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.copyFile({ srcPath: "demo.txt",
                destPath: "test.txt",
                success: function () { console.log("success"); },
                fail: function (res) { console.dir(res.errMsg); },
                complete: function () { console.log("complete"); }
            });

getFileInfo(Object object)

获取文件信息。

参数 Object object

属性 类型 描述
filePath String 要获取信息的文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性 类型 描述
size Number 文件大小,以字节为单位

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.getFileInfo({ filePath: "test.txt",
                   success: function (res) { console.dir(res); },
                   fail: function (res) { console.dir(res.errMsg); },
                  complete: function () { console.log("complete"); } 
                });

mkdir(Object object)

创建目录。

参数 Object object

属性 类型 描述
dirPath String 要创建的目录路径
recursive Bool 是否在递归创建该目录的上级目录后再创建该目录。
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性 类型 描述
size Number 文件大小,以字节为单位

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.mkdir({ dirPath: "demo",
             success: function () { console.log("success"); },
             fail: function (res) { console.dir(res.errMsg); },
             complete: function () { console.log("complete"); }
            });

readFile(Object object)

读取本地文件内容。

参数 Object object

属性 类型 描述
filePath String 要读取的文件的路径
encoding String 指定读取文件的字符编码,如果不传 encoding,则以 Buffer 格式读取文件的二进制内容。
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.encoding 的合法值

描述
utf8 以字符串内容读取

object.success 回调函数

属性 类型 描述
data String/Buffer 文件内容

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.readFile({ filePath: "test.txt",
                encoding: "utf8",
                success: function (res) { console.dir(res); },
                fail: function (res) { console.dir(res.errMsg); },
                complete: function () { console.log("complete"); }
            });

readdir(Object object)

读取目录内文件列表。

参数 Object object

属性 类型 描述
dirPath String 要读取的目录路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

属性 类型 描述
files Array.string 指定目录下的文件名数组

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
    file.readdir({ dirPath: "demo",
                   success: function (res) { console.dir(res.files); },
                   fail: function (res) { console.dir(res.errMsg); },
                   complete: function () { console.log("complete"); }
                });

rename(Object object)

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

参数 Object object

属性 类型 描述
oldPath String 源文件路径
newPath String 新文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.rename({ oldPath: "test.txt",
              newPath: "demo.txt",
              success: function () { console.log("success"); },
              fail: function (res) { console.log("fail " + res.errMsg); },
              complete: function () { console.log("complete"); }
            });

rmdir(Object object)

删除目录。

参数 Object object

属性 类型 描述
dirPath String 要删除的目录路径
recursive Bool 是否递归删除目录。如果为 true,则删除该目录和该目录下的所有子目录以及文件。
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.rmdir({ dirPath: "demo",
             success: function () { console.log("success"); },
             fail: function (res) { console.dir(res.errMsg); },
             complete: function () { console.log("complete"); }
            });

stat(Object object)

获取文件 Stats 对象。

参数 Object object

属性 类型 描述
path String 文件/目录路径
recursive Bool 是否递归获取目录下的每个文件的 Stats 信息
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.success 回调函数

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

Stats 对象

属性 类型 描述
isDir Bool true 则为目录
isFile Bool true 则为文件
size Number 文件大小

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.stat({ path: "demo",
            recursive: false,
            success: function (res) { console.dir(res.stats); },
            fail: function (res) { console.log(res.errMsg); },
            complete: function () { console.log("complete"); }
        });

unlink(Object object)

删除文件。功能与 removeFile 类似。

参数 Object object

属性 类型 描述
filePath String 要删除的文件路径
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.unlink({ filePath: "test.txt",
              success: function () { console.log("success"); },
              fail: function (res) { console.dir(res.errMsg); },
              complete: function () { console.log("complete"); }
            });

writeFile(Object object)

写文件,如果文件不存在则创建该文件,存在时覆盖写入。

参数 Object object

属性 类型 描述
filePath String 要写入内容的文件路径
data String/Buffer 要写入文件的数据
success Function 接口调用成功的回调函数
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

object.fail 回调函数

属性 类型 描述
errMsg String 错误信息

注:返回值 Bool 类型,true 调用成功,false 调用失败。

var file = pm.getFileSystemManager();
file.writeFile({ filePath: "test.txt",
                 data: "test.txt",
                 success: function () { console.log("success"); },
                 fail: function (res) { console.dir(res.errMsg); },
                 complete: function () { console.log("complete"); }
                });