7 uap mobile api referenceuap_plug_apiuexfilemgr

1、uexFileMgr1、简介 2、API概览 3、更新历史 1、简介该对象主要封装了文件操作,主要包含创建文件,打开文件,以及文件提供过路径或者文件对象进行文件增,删,改,查等,读取文件内容,限 utf-8编码txt文件,以及文本阅读器等多个接口.1.1 、说明文件路径包括: wgt:/. , res:/. , wgts:/. , file:/. , http:/. , https:/. 其中: wgt:/. 对应widget的沙盒根路径,可读可写 res:/. 对应widget目录下的wgtRes路径,只可读不可写 关于文件路径的使用,可调用uexFileMgr.getFileRealPat

2、h接口获得文件真实路径作为参考 1.2 、UI展示createmkdiropendeleteFileByPathisFileExistByPathgetFileTypeByPathexplorermultiExplorer seekFileseekBeginOfFileseekEndOfFilewriteFilereadFilegetFileSizegetFilePathgetFileRealPathcloseFilegetReaderOffsetreadPercentreadNextreadPreopenWithPasswordcreateWithPasswordrenameFilesear

3、chgetFileListByPathgetFileSizeByPathcopy getFileHashValue1.3、开源源码插件测试用例与源码下载:点击插件中心至插件详情页 (插件测试用例与插件源码已经提供)1.4、平台版本支持本插件的所有API默认支持Android4.0+和iOS7.0+操作系统 有特殊版本要求的API会在文档中额外说明1.5、接口有效性本插件所有API默认在插件版本4.0.0+可用 在后续版本中新添加的接口会在文档中额外说明 2、API概览2.1、方法create /创建文件uexFileMgr.create(param)说明:创建文件参数:参数名称参数类型是否必选

4、说明paramObject是文件设置var param = path:各字段含义如下:字段名称类型是否必选说明pathString文件路径.支持wgt:/,wgts:/、file:/协议 是返回值:uexFile对象 file 创建失败时返回null示例:var file =uexFileMgr.create( path: wgt:/data/1.txt);if(!file)alert(创建失败!);mkdir /创建文件夹uexFileMgr.mkdir(param)说明:创建文件夹参数:参数名称参数类型是否必选说明paramObject是文件夹设置var param = path:各字段含

5、义如下:字段名称类型是否必选说明pathString文件夹路径.支持wgt:/,wgts:/、file:/协议 是返回值:Boolean类型,是否创建成功 示例:var ret =uexFileMgr.mkdir( path: wgt:/data/test/);open /打开文件uexFileMgr.open(param)说明:打开文件参数:参数名称参数类型是否必选说明paramObject是文件设置var param = path:, mode:各字段含义如下:字段名称类型是否必选说明pathString文件路径.支持wgt:/,wgts:/、file:/协议 是modeNumber打开设

6、置,1-可读 2-可写 4-不存在时创建新文件,可累加,如1+2 = 3表示可读可写.是返回值:uexFile对象file 打开失败时返回null示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);if(!file)alert(打开失败!);deleteFileByPath /根据路径删除文件uexFileMgr.deleteFileByPath(path)说明:根据路径删除文件 参数:参数名称参数类型是否必选说明pathString文件路径,支持wgt:/,wgts:/,file:/ 协议 是返回值:Boolean类型,

7、是否删除成功 示例:var ret = uexFileMgr.deleteFileByPath(wgt:/data/test.txt); alert(ret);isFileExistByPath /根据路径判断文件是否存在uexFileMgr.isFileExistByPath(path)说明:根据路径判断文件是否存在 参数:参数名称参数类型是否必选说明pathString文件路径,支持wgt:/,wgts:/,file:/ 协议 是返回值:Boolean类型,是否存在 示例:var ret = uexFileMgr.isFileExistByPath(wgt:/data/test.txt);

8、 alert(ret);getFileTypeByPath /根据路径获取文件类型uexFileMgr.getFileTypeByPath(path)说明:根据路径获取文件类型 参数:参数名称参数类型是否必选说明pathString文件路径,支持wgt:/,wgts:/,file:/ 协议 是返回值:Number类型, -1:文件不存在或发生未知错误 0:文件 1:文件夹示例:var ret = uexFileMgr.getFileTypeByPath(wgt:/data/test.txt); alert(ret);explorer /文件管理器uexFileMgr.explorer(fold

9、erPath,cbFunc)说明:文件管理器参数:参数名称参数类型是否必选说明folderPathString起始文件夹路径,支持wgt:/,wgts:/,res:/,file:/ 协议 是cbFuncFunction文件浏览结束后,会调用此函数,函数参数说明见下 是回调参数:参数名称参数类型说明errorNumber是否发生错误. 未发生错误时error为0, 发生错误或者用户取消选择时error为非0值 参p参a数th 名称参S参tr数ing类型说用说户明选择的文件的路径;若用户取消选择,则path为null示例:uexFileMgr.explorer(/sdcard/widgetone,

10、function(err,path) if(!err)alert(path);elsealert(err););multiExplorer /文件管理器,支持选择多个文件uexFileMgr.multiExplorer(path,cb)说明:文件管理器,支持选择多个文件 参数:参数名称参数类型是否必选说明pathString文件路径,支持wgt:/,wgts:/,res:/,file:/ 协议 是cbFunction文件浏览结束后,会调用此函数,函数参数说明见下 是回调参数:参数名称参数类型说明errorNumber是否发生错误. 未发生错误时error为0, 发生错误或者用户取消选择时err

11、or为非0值 pathsArray用户选择的文件的路径构成的数组;若用户未选择任何文件,则path为空数组 示例:uexFileMgr.multiExplorer(/sdcard/widgetone,function(err,path) i f(!err)alert(path);elsealert(err););seekFile /定位到文件某一位置uexFileMgr.seekFile(file,len)说明:定位到文件某一位置 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是lenNumber是字节数返回值:Number类型文件偏移值,-1表示定位失败.示

12、例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);var ret = uexFileMgr.seekFile(file, 1); alert(ret);seekBeginOfFile /定位到起始位置uexFileMgr.seekBeginOfFile(file)说明:定位到起始位置 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是返回值:Number类型文件偏移值,-1表示定位失败.示例:var file =uexFileMgr.open( path: wgt:/data/1.txt,

13、mode: 3);var ret = uexFileMgr.seekBeginOfFile(file); alert(ret);seekEndOfFile /定位到结束位置uexFileMgr.seekEndOfFile(file)说明:定位到结束位置 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是返回值:Number类型文件偏移值,-1表示定位失败.示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);var ret = uexFileMgr.seekEndOfFile(file); a

14、lert(ret);writeFile /写文件uexFileMgr.writeFile(file,flag,data,cb)说明:写文件参数:参数名称参数类型是否必选说明fileStringuexFile对象file是flagNumber写入设置(详见下)是dataString是要写入的数据cbFunction写入结束后,会调用此函数,函数参数说明见下 是flag是一个枚举值,将所需设置对应的值传入即可.可累加,比如 flag传3 (= 1+2) 表示先进行base64解码,再追加写入. 不需要这些额外设置时,flag请传0含释flag1Append包含此flag时,数据会追加写入到指定的文

15、件2Base64Decode包含此flag时,插件会先对传入的字符串进行base64解码,然后将解码后的数据写入文件回调参数:参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);uexFileMgr.writeFile(file, 0, test,function(err) alert(err););readFile /读文件uexFileMgr.readFile(file,len,flag,cb)说明:读文件参数:参数名称参数类型是否必选说明file

16、StringuexFile对象file是lenNumber字节数,传-1表示读取全部内容是flagNumber读取设置(详见下)是cbFunction读取结束后,会调用此函数,函数参数说明见下 是flag是一个枚举值,将所需设置对应的值传入即可.同时需要多种设置时,应将设置对应的flag相加后再传入. 不需要这些额外设置时,flag请传0.flag含释1Base64Encode包含此flag时,插件会对读取到的数据先进行base64编码,再传回给前端 回调参数:var cb = function(error,data)参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败da

17、taString读取到的数据,读取失败时返回null示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);uexFileMgr.readFile(file, - 1,0,function(error,data) if(!error)alert(data);elsealert(读取失败!););getFileSize /获取文件大小uexFileMgr.getFileSize(file)说明:获取文件大小参数:参数名称参数类型是否必选说明fileStringuexFile对象file是返回值:Number类型文件大小,读取失败

18、时返回-1.示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);var size = uexFileMgr.getFileSize(file); alert(size);getFilePath /获取文件路径uexFileMgr.getFilePath(file)说明:获取文件路径参数:参数名称参数类型是否必选说明fileStringuexFile对象file是返回值:String类型,文件路径 示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);va

19、r path = uexFileMgr.getFilePath(file); alert(path);getFileRealPath /获取文件实际路径uexFileMgr.getFileRealPath(path)说明:获取文件实际路径 参数:参数名称参数类型是否必选说明pathString文件路径,支持wgt:/,wgts:/,res:/,file:/ 协议 是返回值:String类型,文件绝对路径 示例:var realPath = uexFileMgr.getFileRealPath(wgt:/data/test.txt); alert(realPath);closeFile /关闭文

20、件uexFileMgr.closeFile(file)说明:关闭文件参数:参数名称参数类型是否必选说明fileStringuexFile对象file是返回值:Boolean类型,是否关闭成功 示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);var ret = uexFileMgr.closeFile(file); alert(ret);getReaderOffset /获取文件偏移值uexFileMgr.getReaderOffset(file)说明:获取文件偏移值 参数:参数名称参数类型是否必选说明fileStrin

21、guexFile对象file是返回值:Number类型文件偏移值 获取失败时返回-1 示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);var offset = uexFileMgr.getReaderOffset(file); alert(offset);readPercent /读百分比对应位置的字符uexFileMgr.readPercent(file,percent,len,cb)说明:读百分比对应位置的字符 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是是 是否必选perce

22、ntNumber百分比(不带百分号)参数名称参数类型说明lenNumber字节数,读取百分比之后的字节长度 是cbFunction读取结束后,会调用此函数,函数参数说明见下 是回调参数:var cb = function(error,data)参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败dataString读取到的数据,读取失败时返回null示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);uexFileMgr.readPercent(file,20,3,function(error,data

23、) if (!error)alert(data);elsealert(ERROR!););readNext /读取下一页字符uexFileMgr.readNext(file,len,cb)说明:读取下一页字符 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是lenNumber是字节数cbFunction读取结束后,会调用此函数,函数参数说明见下 是回调参数:var cb = function(error,data)参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败dataString读取到的数据,读取失败时返回null示例:var fil

24、e =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);uexFileMgr.readNext(file, 20,function(error,data) if(!error)alert(data);elsealert(ERROR!););readPre /读取上一页字符uexFileMgr.readPre(file,len,cb)说明:读取上一页字符 参数:参数名称参数类型是否必选说明fileStringuexFile对象file是lenNumber是字节数cbFunction读取结束后,会调用此函数,函数参数说明见下 是回调参数:var cb

25、 = function(error,data)参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败dataString读取到的数据,读取失败时返回null示例:var file =uexFileMgr.open( path: wgt:/data/1.txt, mode: 3);uexFileMgr.readPre(file,20,function(error,data) i f(!error)alert(data);elsealert(ERROR!););openWithPassword /使用打开文件uexFileMgr.openWithPassword(param)说明

26、:使用打开文件 参数:参数名称参数类型是否必选说明paramObject是文件设置var param = path:, password:, mode:各字段含义如下:字段名称类型是否必选说明pathString文件路径.支持wgt:/,wgts:/、file:/协议 是passwordString是文件modeNumber打开设置,1-可读 2-可写 4-不存在时创建新文件,可累加,如1+2 = 3表示可读可写.是返回值:uexFile对象file 打开失败时返回null示例:var file =uexFileMgr.openWithPassword( path: wgt:/data/1.t

27、xt,password: 123456,mode: 3);if(!file)alert(打开失败!);createWithPassword /使用创建文件uexFileMgr.createWithPassword(param)说明:使用创建文件 参数:参数名称参数类型是否必选说明paramObject是文件设置var param = path:, password:字段名称类型是否必选说明pathString文件路径.支持wgt:/,wgts:/、file:/协议 是passwordString是文件返回值:uexFile对象file 创建失败时返回null示例:var file =uexFi

28、leMgr.createWithPassword( path: wgt:/data/1.txt,password: 123456,);if(!file)alert(创建失败!);renameFile /重命名文件uexFileMgr.renameFile(param,cb)说明:重命名文件参数:参数名称参数类型是否必选说明paramStringparam是字典结构json字符串,详情见下 是cbFunction重命名结束后,会调用此函数,函数参数说明见下 是var param = oldFilePath:,newFilePath:各字段含义如下:字段名称类型是否必选说明oldFilePathS

29、tring是重命名前的文件路径 newFilePathString是重命名后的文件路径 回调参数:var cb = function(error)参数名称参数类型说明errorNumber重命名操作结果,为0表示成功 非0时表示失败示例:var data = oldFilePath:wgt:/1.txt,newFilePath:wgt:/2.txtuexFileMgr.renameFile(JSON.stringify(data),function(err) i f(!err)alert(重命名成功!);elsealert(重命名失败!););search /搜索文件uexFileMgr.se

30、arch(param,cb)说明:搜索文件参数:参数名称参数类型是否必选说明paramStringparam是字典结构json字符串,详情见下 是cbFunction搜索操作结束后,会调用此函数,函数参数说明见下 是var param = path:, flag:, keywords:, suffixes:各字段含义如下:字段名称类型是否必选说明pathString是目标文件夹路径 flagNumber搜索设置 见下 不传默认为0否keywordsArray否要搜索的文件名关键字 不传时搜索所有 suffixesArray否要搜索的文件后缀名 不传时搜索所有 flag说明1匹配文件夹 也搜索符

31、合条件的文件夹(有设置suffixes时,此项设置失效)2精确匹配 只搜索文件名恰为keyword的文件 4递归搜索 搜索目标文件夹及其子文件夹 需要多项设置时 请将各flag值相加再传入.比如传5 (=4+1),表示既递归搜索,又匹配文件夹回调参数:var cb = function(error,result)参数名称参数类型说明errorNumber为0时表示成功,非0时表示失败resultArray搜索操作结果,所有符合条件的路径构成的数组;若没有路径符合搜索条件,则为一个空数组 示例:var data = path:res:/, flag:5, keywords:name1,name2

32、,name3, suffixes:txt,xmluexFileMgr.search(JSON.stringify(data),function(err,result) i f(!err)alert(result);elsealert(搜索失败!););getFileListByPath /获取某路径下的所有文件uexFileMgr.getFileListByPath(path)说明:获取某路径下的所有文件 参数:参数名称参数类型是否必选说明pathString文件夹路径,支持wgt:/, wgts:/, file:/协议路径 是返回值:path无效或者不是文件夹 返回null空文件夹 返回空数

33、组 正常情况 返回路径信息构成的数组Array,路径信息结构定义如下 var fileInfo = fileName:, filePath:, fileType:各字段含义如下:字段名称类型说明fileNameString文件名filePathString文件路径fileTypeNumber类型.0-文件 1-文件夹示例:var path = wgt:/var result = uexFileMgr.getFileListByPath(path); alert(result);getFileSizeByPath /通过路径获取文件或文件夹大小uexFileMgr.getFileSizeByPa

34、th(params,cb)说明:通过路径获取文件或文件夹大小 参数:参数名称参数类型是否必选说明paramStringparam是字典结构json字符串,详情见下 是cbFunction操作结束后,会调用此函数,函数参数说明见下 是var params = path:, unit:各字段含义如下:字段名称类型是否必选说明pathString文件或文件夹路径,支持wgt:/, wgts:/, file:/协议路径,参考协议 是unitString文件大小单位,默认为B,取值范围参考unit否回调参数:var cb = function(error,info)参数名称参数类型说明errorNumb

35、er为0表示操作成功,非0时表示操作失败infoObject操作获取到的结果 var info = unit:,/String,文件大小单位data:/Number,文件大小 示例:var params = path:wgt:/, unit:KBvar data = JSON.stringify(params); uexFileMgr.getFileSizeByPath(data,function(err,info)if(!err)alert(info.data);elsealert(ERROR!););copy /复制文件或文件夹uexFileMgr.copy(param,cbFunc);说明:复制文件或文件夹 参数:参数名称参数类型是否必选说明paramObject复制操作的参数,详见下 是cbFuncFunction操作结束后,会调用此函数 是var param = src:, target:各字段含义如下:字段名称类型是否必选说明srcString是源文件或文件夹路径 targetString是目标文件夹路径 copy会将源文件或者文