fileManager


fileManager封装了对文件操作的接口,通过此模块可对文件进行创建、删除,读取、写入等相关操作。开发者简单几个接口即可操作文件,极大简化了前端代码的组织

注:此文档中提到的路径可以使用协议路径,具体参考云学院"协议路径"文档;对于android开发人员也可以自己填写绝对路径

打开模式(Number):

  • rd.fileManager.READ(0) : 只读

  • rd.fileManager.WRITE(1) : 只写

  • rd.fileManager.READ_WRITE(2) : 读写

方法:

对象:

  • Params : Json对象,获取文件返回的属性值

回调函数:

####

createDirectory


创建目录

rd.fileManager.createDirectory(path,succCallback,failCallback);            

#####说明:

在指定路径path下创建目录文件夹,成功执行succCallback函数,失败执行failCallback函数。

#####参数:

  • path: ( String ) 必选 目标路径,不能为空。
  • succCallback: ( succCallback) 必选 创建目录成功的回调函数。
  • failCallback: ( failCallback) 必选 创建目录失败的回调函数。

#####返回值:

无返回值

#####示例:

    function succCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }
     rd.fileManager.createDirectory('data://testDocument', succCallback, failCallback);

####

createFile


创建文件

rd.fileManager.createFile(path,succCallback,failCallback);            

#####说明:

在指定路径path下创建文件,成功执行succCallback函数,失败执行failCallback函数。

#####参数:

  • path: ( String ) 必选 目标路径,不能为空。
  • succCallback: ( succCallback) 必选 创建文件成功的回调函数。
  • failCallback: ( failCallback) 必选 创建文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function succCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }

   rd.fileManager.createFile('data://testFile.txt', succCallback, failCallback);

####

removeFile


删除文件

rd.fileManager.removeFile(path,succCallback,failCallback);            

#####说明:

删除指定路径path下的文件,成功执行succCallback函数,失败执行failCallback函数。

#####参数:

  • path: ( String ) 必选 目标路径,不能为空。
  • succCallback: ( succCallback) 必选 删除文件成功的回调函数。
  • failCallback: ( failCallback) 必选 删除文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function succCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }

    rd.fileManager.removeFile('data://testDocument/testFile2.txt', succCallback, failCallback);

####

copy


拷贝文件

rd.fileManager.copy(oldPath,newPath,succCallback,failCallback);            

#####说明:

将源路径oldpath的文件拷贝到新路径newpath中,成功执行succCallback函数,失败执行failCallback函数。

#####参数:

  • oldPath: ( String ) 必选 源路径,不能为空。
  • newPath: ( String ) 必选 目标路径,不能为空。
  • succCallback: ( succCallback) 必选 拷贝文件成功的回调函数。
  • failCallback: ( failCallback) 必选 拷贝文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function succCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }

    rd.fileManager.copy('data://testFile.txt', 'data://testDocument', succCallback, failCallback);     

####

move


移动文件

rd.fileManager.move(oldPath,newPath,succCallback,failCallback);            

#####说明:

将源路径oldpath的文件移动到新路径newpath中,成功执行succCallback函数,失败执行failCallback函数。

#####参数:

  • oldPath: ( String ) 必选 源路径,不能为空。
  • newPath: ( String ) 必选 目标路径,不能为空。
  • succCallback: ( succCallback) 必选 移动文件成功的回调函数。
  • failCallback: ( failCallback) 必选 移动文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function succCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }

    rd.fileManager.move('data://testFile.txt', 'data://testDocument/testFile.txt', succCallback, failCallback); 

####

readDirectory


列出目录

rd.fileManager.readDirectory(Path,readDirectorySuccCallback,failCallback);            

#####说明:

获取path目录下的所有文件名称,成功执行readDirectorySuccCallback函数,失败执行failCallback函数。

#####参数:

  • Path: ( String ) 必选 目标路径,不能为空。
  • readDirectorySuccCallback: ( readDirectorySuccCallback) 必选 列出目录文件成功的回调函数。
  • failCallback: ( failCallback) 必选 列出目录文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function readDirectorySuccCallback(msg) {
            alert(msg);
    }
    function failCallback(msg) {
        alert(msg);
    }

    rd.fileManager.readDirectory('data://', readDirectorySuccCallback, failCallback);

####

open


打开文件

rd.fileManager.open(Path,Mode,openSuccCallback,failCallback);

#####说明:

根据文件打开模式,打开path路径的文件,成功执行openSuccCallback函数,失败执行failCallback函数。

#####参数:

  • Path: ( String ) 必选 目标路径 不能为空。
  • Mode: ( 打开模式) 必选 打开文件模式
  • openSuccCallback: ( openSuccCallback) 必选 打开文件成功的回调函数。
  • failCallback: ( failCallback) 必选 打开文件失败的回调函数。

#####返回值:

无返回值

#####示例:

    function failCallback(msg) {
        alert(msg);
    }
    function openSuccCallback(fd) {
          alert(fd);
    }

    function openWriteFile() {
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

seekToEnd


跳转到文件末尾

rd.fileManager.seekToEnd(fd);            

#####说明:

操作文件时,文件的位置指针指向到到文件末尾。

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。

#####返回值:

无返回值

#####示例:

    function failCallback(msg) {
        alert(msg);
    }
    function openSuccCallback(fd) {
         rd.fileManager.seekToEnd(fd);     
    }

    function openWriteFile() {
        //打开文件并跳转到文件末尾
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

seekToFileOffset


跳转到文件的指定位置

rd.fileManager.seekToFileOffset(fd,num,callback);            

#####说明:

操作文件时,文件的位置指针指向到文件指定位置。

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。
  • num: ( Number ) 必选 跳转到文件指定位置(字节数)。
  • callback:(callback) 可选 回调函数

#####返回值:

无返回值

#####示例:

     function failCallback(msg) {
        alert(msg);
    }
    function openSuccCallback(fd) {
         rd.fileManager.seekToFileOffset(fd,10,callback); 
    }

    function openWriteFile() {
        //打开文件并跳转到文件的指定位置
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

readToEnd


读取文件到末尾

rd.fileManager.readToEnd(fd,succCallback,failCallback);                

#####说明:

读取文件到末尾,文件句柄必须是只读或读写方式打开的,否则会引起异常。

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。
  • succCallback: ( succCallback) 必选 读取成功的回调函数。
  • failCallback: ( failCallback) 必选 读取失败的回调函数。

#####返回值:

无返回值

#####示例:

    function failCallback(msg) {
        alert(msg);
    }

    function succCallback(msg) {
        alert(msg);
    }

    function openSuccCallback(fd) {
        rd.fileManager.readToEnd(fd,succCallback,failCallback);
    }

    function openWriteFile() {
        //打开文件并读取文件到末尾
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

readDataOfLength


读取指定长度的文件

rd.fileManager.readDataOfLength(fd,num,succCallback,failCallback);    

#####说明:

读取指定长度的文件,文件句柄必须是只读或读写方式打开的,否则会引起异常。

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。
  • num: ( Number ) 必选 读取文件的长度(按字节读取)。
  • succCallback: ( succCallback) 必选 读取成功的回调函数。
  • failCallback: ( failCallback) 必选 读取失败的回调函数。

#####返回值:

无返回值

#####示例:

    function failCallback(msg) {
        alert(msg);
    }

    function succCallback(msg) {
        alert(msg);
    }

    function openSuccCallback(fd) {
          rd.fileManager.readDataOfLength(fd,10,succCallback,failCallback);
    }

    function openWriteFile() {
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

writeData


写文件

rd.fileManager.writeData(fd,text);    

#####说明:

将数据写入文件,文件句柄必须是只写或读写方式打开的,否则会引起异常。

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。
  • text: ( String ) 必选 写入的内容

#####返回值:

无返回值

#####示例:

     function failCallback(msg) {
        alert(msg);
    }
    function openSuccCallback(fd) {
       rd.fileManager.writeData(fd,‘ssssssssssss’);
    }

    function openWriteFile() {
        //打开指定文件并给文件写数据
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

close


关闭文件

rd.fileManager.close(fd);    

#####说明:

关闭文件

#####参数:

  • fd: ( Number ) 必选 目标文件句柄 不能为空。

#####返回值:

无返回值

#####示例:

     function failCallback(msg) {
        alert(msg);
    }
    function openSuccCallback(fd) {
        rd.fileManager.close(fd);
    }

    function openWriteFile() {
        //关闭指定文件
        rd.fileManager.open('data://testFile.txt', rd.fileManager.READ_WRITE, openSuccCallback, failCallback);
    }

####

exist


判断文件是否存在

var result = rd.fileManager.exist(path);    

#####说明:

判断文件是否存在

#####参数:

  • path: ( String ) 必选 文件路径 不能为空。

#####返回值:

  • result: ( Boolean ) 如果文件存在,返回true,否则返回false。

#####示例:

       var result = rd.fileManager.exist('data://testFile.txt');
        if (result) {
            alert('存在此文件');
        } else {
            alert('不存在此文件');
       } 

####

getFileAttribute


获取指定路径下文件的属性

rd.fileManager.getFileAttribute(path,attributeCallback,failCallback);                

#####说明:

获取指定路径下文件的属性

#####参数:

  • path: ( String ) 必选 文件路径 不能为空。
  • attributeCallback: ( attributeCallback) 必选 获取目录执行成功的回调函数
  • failCallback: ( failCallback ) 必选 执行失败的回调函数

#####返回值:

无返回值

#####示例:

    function failCallback(msg) {
        alert(msg);
    }

    function open() {
        rd.fileManager.getFileAttribute('data://testFile.txt',attributeCallback,failCallback);           
    }

     function attributeCallback(params) {
          alert(params);                 
    }

####

getFileSize


获取文件的大小,仅安卓可用.

#####参数:

  • path: ( String ) 必选 文件路径 不能为空。

#####返回值:

  • size: ( Number ) 文件的大小。

#####示例:

    var size = rd.fileManager.getFileSize('/storage/emulated/0/test.zip')

####

succCallback


文件操作成功的回调函数

void succCallback( messgae ) {
}

#####参数:

  • messgae: ( String ) 必选 文件操作成功的返回信息

#####返回值:

无返回值

####

failCallback


文件操作失败的回调函数

void failCallback( message ) {
}

#####参数:

  • messgae: ( String ) 必选 文件操作失败的返回信息

#####返回值:

无返回值

####

readDirectorySuccCallback


获取文件夹目录成功的回调

void readDirectorySuccCallback( params ) {
}

#####参数:

  • params: ( Array ) 必选 获取文件夹目录返回的数组,包含文件夹内文件的名称

#####返回值:

无返回值

####

openSuccCallback


打开文件成功的回调函数

void openSuccCallback( fd ) {
}

#####参数:

  • fd: ( Number ) 必选 文件的句柄

#####返回值:

无返回值

####

attributeCallback


获取文件属性成功的回调函数

void attributeCallback( params ) {

}

#####参数:

  • params: ( Params ) 必选 获取文件返回属性值

#####返回值:

无返回值

####

callback


跳转到指定位置的回调函数

void callback( params ) {

}

#####参数:

  • params: ( String ) 必选 回调的返回参数

#####返回值:

无返回值

####

Params


获取属性回调返回参数

Params 
{          
    property String createDate;
      property String modificationDate;
      property Number fileSize;
}

#####说明:

JSON对象,用于获取返回文件信息。

#####属性:

  • createDate : ( String ) 必选 文件创建日期 (iOS支持此属性,Android不支持)
  • modificationDate : ( String ) 必选 文件最后修改日期
  • fileSize : ( Number ) 必选 文件大小