AppCan文档中心-uexFileMgr
 
下载文档

uexFileMgr
更新时间:2016-09-09

1、简介

该对象主要封装了文件操作,主要包含创建文件,打开文件,以及文件提供过路径或者文件对象进行文件增,删,改,查等,读取文件内容,限utf-8编码txt文件,以及文本阅读器等多个接口。

1.1、说明

文件路径包括:wgt://...,res://...,wgts://...,box://...,file://...,http://...
其中: wgt://..对应widget的沙盒根路径,可读可写;
res://…对应widget目录下的wgtRes路径,只可读不可写。

关于文件路径的使用,可调用uexFileMgr.getFileRealPath接口获得文件真实路径作为参考

1.2、UI展示

1.3、开源源码

插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

2、API概览

2.1、方法

createFile 创建文件

uexFileMgr.createFile(id,path)

说明:

创建文件,同一id只能被创建一次。回调方法cbCreateFile

参数:

参数名称 参数类型 是否必选 说明
id Number 唯一标识符
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. var path = "wgt://data/test.txt";
  2. uexFileMgr.createFile(1, path);

createDir 创建文件夹

uexFileMgr.createDir(id,dirPath)

说明:

创建文件夹,回调方法cbCreateDir

参数:

参数名称 参数类型 是否必选 说明
id Number 唯一标识符
dirPath String 文件夹路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. var path = "wgt://data/test2/";
  2. uexFileMgr.createDir(20, path);

openFile 打开文件

uexFileMgr.openFile(id,path,mode)

说明:

打开文件,回调方法cbOpenFile

参数:

参数名称 参数类型 是否必选 说明
id Number 唯一标识符
path String 文件路径,路径协议详见CONSTANT中PathTypes
mode String 文件打开模式,详见CONSTANT中FileOpenModes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1,"res://reader.txt",'1');

deleteFileByPath 根据路径删除文件

uexFileMgr.deleteFileByPath(path)

说明:

根据路径删除文件,回调方法cbDeleteFileByPath

参数:

参数名称 参数类型 是否必选 说明
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.deleteFileByPath("wgt://data/test.txt");

deleteFileByID 根据id删除文件

uexFileMgr.deleteFileByID(id)

说明:

根据id删除文件,回调方法cbDeleteFileByID

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.deleteFileByID(1);

isFileExistByPath 根据路径判断文件是否存在

uexFileMgr.isFileExistByPath(id, path)

说明:

根据路径判断文件是否存在,回调方法cbIsFileExistByPath

参数:

参数名称 参数类型 是否必选 说明
id Number 文件的唯一标识符,与回调函数中的opId对应
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.isFileExistByPath(2,"wgt://data/test.txt");

isFileExistByID 根据id判断文件是否存在

uexFileMgr.isFileExistByID(id)

说明:

根据id判断文件是否存在,回调方法cbIsFileExistById

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.isFileExistByID(2);

getFileTypeByPath 根据路径获取文件类型

uexFileMgr.getFileTypeByPath(path)

说明:

根据路径获取文件类型,回调方法cbGetFileTypeByPath

参数:

参数名称 参数类型 是否必选 说明
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.getFileTypeByPath("wgt://data/test.txt");

getFileTypeByID 根据id获取文件类型

uexFileMgr.getFileTypeByID(id)

说明:

根据id获取文件类型,回调方法cbGetFileTypeById

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.getFileTypeByID(4);

explorer 文件管理器

uexFileMgr.explorer(path)

说明:

文件管理器,回调方法cbExplorer

参数:

参数名称 参数类型 是否必选 说明
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.explorer("/sdcard/widgetone");

multiExplorer 文件管理器(多选)

uexFileMgr.multiExplorer(path)

说明:

文件管理器,支持选择多个文件,回调方法cbMultiExplorer的回调方法 “cbMultiExplorer”)

参数:

参数名称 参数类型 是否必选 说明
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.multiExplorer("/sdcard/widgetone");

seekFile 定位到文件某一位置

uexFileMgr.seekFile(id,len)

说明:

定位到文件某一位置

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
len Number 字节数

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.seekFile(1, 1);

seekBeginOfFile 定位到起始位置

uexFileMgr.seekBeginOfFile(id)

说明:

定位到起始位置

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(', "wgt://test.txt", '1');
  2. uexFileMgr.seekBeginOfFile(1);

seekEndOfFile 定位到结束位置

uexFileMgr.seekEndOfFile(id)

说明:

定位到结束位置

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.seekEndOfFile(1);

writeFile 写文件

uexFileMgr.writeFile(id,option,data)

说明:

写文件,回调方法cbWriteFile  

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
option Number 写入设置(详见下)
data String 要写入的数据
  • uexFileWritingOption是一个枚举值,将所需设置对应的flag传入即可。
  • 同时需要多种设置时,应将设置对应的flag相加后再传入。比如 option传3 (= 1+2) 意味着先进行base64解码,再追加写入.
  • 不需要这些额外设置时,option请传0
flag 含义 解释
1 Append 包含此flag时,数据会追加写入到指定的文件
2 Base64Decode 包含此flag时,插件会先对传入的字符串进行base64解码,然后将解码后的数据写入文件

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.writeFile(1, 0, "test");

readFile 读文件

uexFileMgr.readFile(id,len,option)

说明:

读文件,回调方法cbReadFile

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
len Number 字节数,”-1”-全部读取
option Number 读取设置(详见下),默认为0
  • uexFileReadingOption是一个枚举值,将所需设置对应的flag传入即可。
  • 同时需要多种设置时,应将设置对应的flag相加后再传入。
  • 不需要这些额外设置时,option请传0
flag 含义 解释
1 Base64Encode 包含此flag时,插件会对读取到的数据先进行base64编码,再传回给前端

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.readFile(1, -1);

getFileSize 获取文件大小

uexFileMgr.getFileSize(id)

说明:

获取文件大小,回调方法cbGetFileSize

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.getFileSize(1);

getFilePath 获取文件路径

uexFileMgr.getFilePath(id)

说明:

获取文件路径, 回调方法cbGetFilePath

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openFile(1, "wgt://test.txt", '1');
  2. uexFileMgr.getFilePath(1);

getFileRealPath 获取文件实际路径

uexFileMgr.getFileRealPath(path, cbName)

说明:

获取文件实际路径,回调方法cbGetFileRealPath

参数:

参数名称 参数类型 是否必选 说明
path String 文件路径,路径协议详见CONSTANT中PathTypes
cbName String 指定的回调函数名,使用此方法回调,只回调给前端一个参数realPath

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.getFileRealPath("wgt://data/test.txt", "cbName");

closeFile 关闭文件

uexFileMgr.closeFile(id)

说明:

关闭文件

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.closeFile(1);

getReaderOffset 获取文件偏移值

uexFileMgr.getReaderOffset(id)

说明:

获取文件偏移值, 回调方法cbGetReaderOffset

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.getReaderOffset(1);

readPercent 读百分比对应位置的字符

uexFileMgr.readPercent(id,percent,len)

说明:

读百分比对应位置的字符,回调方法cbReadPercent

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
percent Number 百分比(不带百分号)
len Number 字节数,读取百分比之后的字节长度

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.readPercent(1,20,3);

readNext 读取下一页字符

uexFileMgr.readNext(id,len)

说明:

读取下一页字符, 回调方法cbReadNext

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
len Number 字节数

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.readNext(1, 20);

readtextarea 读取上一页字符

uexFileMgr.readtextarea(id,len)

说明:

读取上一页字符, 回调方法cbReadtextarea

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
len Number 字节数

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.readtextarea(1,20);

openSecure 使用密码打开文件

uexFileMgr.openSecure(id,path,mode,key)

说明:

使用密码打开文件,回调方法cbOpenSecure

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
path String 文件路径,路径协议详见CONSTANT中PathTypes
mode Number 文件打开模式,详见CONSTANT中FileOpenModes
key String 密码

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.openSecure(100, "wgt://secure.txt", 1, '123456');

createSecure 使用密码创建文件

uexFileMgr.createSecure(id,path,key)

说明:

使用密码创建文件, 回调方法cbCreateSecure

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
path String 文件路径,路径协议详见CONSTANT中PathTypes
key String 密码

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.createSecure(100, "wgt://data/test.txt", '123456');

getFileCreateTime 获取文件或文件夹的创建时间

uexFileMgr.getFileCreateTime(id,path)

说明:

获取文件或文件夹的创建时间, 回调方法cbGetFileCreateTime

参数:

参数名称 参数类型 是否必选 说明
id Number 文件唯一标识符
path String 文件路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.getFileCreateTime(33,'wgt://test.txt');

renameFile 重命名文件

uexFileMgr.renameFile(param)

说明:

重命名文件

回调方法cbRenameFile

参数:

参数名称 参数类型 是否必选 说明
param String param是字典结构json字符串,详情见下
  1. var param = {
  2. oldFilePath:,//必选 String 重命名前的文件路径
  3. newFilePath:,//必选 String 重命名后的文件路径
  4. }

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.9+
Androd 3.0.4+

示例:

  1. var data = {
  2. oldFilePath:"wgt://1.txt",
  3. newFilePath:"wgt://2.txt"
  4. }
  5. uexFileMgr.renameFile(JSON.stringify(data));

search 搜索文件

uexFileMgr.search(param)

说明:

搜索文件

回调方法cbSearch

参数:

参数名称 参数类型 是否必选 说明
param String param是字典结构json字符串,详情见下
  1. var param = {
  2. path:,//必选,String,目标文件夹路径
  3. option:,//可选 Number 搜索设置 见下 不传默认为0
  4. keywords:[]//可选 要搜索的文件名关键字 不传时搜索所有
  5. suffixes:[]//可选 要搜索的文件后缀名 不传时搜索所有
  6. }
option 说明
1 匹配文件夹 也搜索符合条件的文件夹(有设置suffixes时,此项设置失效)
2 精确匹配 只搜索文件名恰为keyword的文件
4 递归搜索 搜索目标文件夹及其子文件夹
  • 需要多项option时 请将各option值相加再传入。比如传5 (=4+1),表示既递归搜索,又匹配文件夹

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.12+
Android 3.0.10+

示例:

  1. var data={
  2. path:"res://",
  3. option:5,
  4. keywords:["name1","name2","name3"],
  5. suffixes:["txt","xml"]
  6. }
  7. uexFileMgr.search(JSON.stringify(data));

getFileListByPath 获取某路径下的所有文件

uexFileMgr.getFileListByPath(path)

说明:

获取某路径下的所有文件

回调方法cbGetFileListByPath

参数:

参数名称 参数类型 是否必选 说明
path String 文件夹路径,支持wgt://, wgts://, file://协议路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.13+
Android 3.0.6+

示例:

  1. var path = "wgt://"
  2. uexFileMgr.getFileListByPath(path);

getFileSizeByPath 通过路径获取文件大小

uexFileMgr.getFileSizeByPath(params)

说明:

通过路径获取文件或文件夹大小,回调方法cbGetFileSizeByPath

参数:

  1. var params = {
  2. id:,
  3. path:,
  4. unit:
  5. }

各字段含义如下:

字段名称 类型 是否必选 说明
id String 唯一标识符,与回调方法中id对应
path String 文件或文件夹路径,支持wgt://, wgts://, file://协议路径 ,路径协议详见CONSTANT中PathTypes
unit String 文件大小单位,默认为”B”,取值范围参考unit

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.17+
Android 3.0.12+

示例:

  1. var params = {
  2. id:1,
  3. path:"wgt://",
  4. unit:"KB"
  5. }
  6. var data = JSON.stringify(params);
  7. uexFileMgr.getFileSizeByPath(data);

copyFile 复制单个文件

uexFileMgr.copyFile(opID, srcFilePath, objPath);

说明:

复制单个文件

回调方法cbCopyFile

参数:

参数名称 参数类型 是否必选 说明
opID String 复制文件任务id
srcFilePath String 源文件路径,支持wgt://, wgts://, res://协议路径,路径协议详见CONSTANT中PathTypes
objPath String 目标文件夹路径,支持wgt://, wgts://, res://协议路径,路径协议详见CONSTANT中PathTypes

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.22+
Android 3.0.13+

示例:

  1. var s = "res://1016.jpg";
  2. var o = "wgt://";
  3. uexFileMgr.copyFile('109',s,o);

2.2、回调方法

cbCreateFile 创建文件的回调方法

uexFileMgr.cbCreateFile(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或uex.cFailed,详见CONTANT中CallbackInt类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbCreateFile = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("创建文件成功");
  4. } else {
  5. alert("创建文件失败");
  6. }
  7. }

cbCreateDir 创建文件夹的回调方法

uexFileMgr.cbCreateDir(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或uex.cFailed,详见CONTANT中CallbackInt类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbCreateDir = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("创建文件夹成功");
  4. } else {
  5. alert("创建文件夹失败");
  6. }
  7. }

cbOpenFile 打开文件的回调方法

uexFileMgr.cbOpenFile(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或uex.cFailed,详见CONTANT中CallbackInt类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbOpenFile=function(opId,dataType,data){
  2. if(data == 0){
  3. alert("打开文件成功");
  4. }else{
  5. alert("打开文件失败");
  6. }
  7. }

cbDeleteFileByPath 根据路径删除文件的回调方法

uexFileMgr.cbDeleteFileByPath(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或uex.cFailed,详见CONTANT中CallbackInt类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbDeleteFileByPath = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("删除成功");
  4. } else {
  5. alert("删除失败");
  6. }
  7. }

cbDeleteFileByID 根据id删除文件的回调方法

uexFileMgr.cbDeleteFileByID(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或uex.cFailed,详见CONTANT中CallbackInt类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbDeleteFileByID = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("删除成功");
  4. } else {
  5. alert("删除失败");
  6. }
  7. }

cbIsFileExistByPath 根据路径判断文件是否存在的回调方法

uexFileMgr.cbIsFileExistByPath(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回的int型的数据,1-存在;0-不存在

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbIsFileExistByPath = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("文件不存在");
  4. } else if (data == 1) {
  5. alert("文件存在");
  6. } else {
  7. alert(data);
  8. }
  9. }

cbIsFileExistByID 根据id判断文件是否存在的回调方法

uexFileMgr.cbIsFileExistByID(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回的int型的数据,1-存在;0-不存在

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbIsFileExistById = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("文件不存在");
  4. } else if (data == 1) {
  5. alert("文件存在");
  6. } else {
  7. alert(data);
  8. }
  9. }

cbGetFileTypeByPath 根据路径获取文件类型的回调方法

uexFileMgr.cbGetFileTypeByPath(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回的int型的数据,1-文件夹;0-文件

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFileTypeByPath = function(opId, dataType, data) {
  2. if (data == 1) {
  3. alert("是文件夹");
  4. } else if (data == 0) {
  5. alert("是文件");
  6. } else {
  7. alert(data);
  8. }
  9. }

cbGetFileTypeByID 根据id获取文件类型的回调方法

uexFileMgr.cbGetFileTypeByID(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回的int型的数据,1-文件夹;0-文件

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFileTypeById = function(opId, dataType, data) {
  2. if (data == 1) {
  3. alert("是文件夹");
  4. } else if (data == 0) {
  5. alert("是文件");
  6. } else {
  7. alert(data);
  8. }
  9. }

cbExplorer 文件管理器的回调方法

uexFileMgr.cbExplorer(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件管理器里选择的文件路径

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbExplorer = function(opId, dataType, data) {
  2. alert(data);
  3. }

cbMultiExplorer 文件管理器(多选)的回调方法

uexFileMgr.cbMultiExplorer(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件管理器里选择的文件的路径列表,json格式如下:Key:索引值,从零开始;Value:返回的路径{“2”:”/sdcard/DCIM/IMG_0003.JPG”,”1”:”/sdcard/DCIM/1337569458885.png”,”0”:”/sdcard/Apks/com.aurorasoftworks4.apk”}

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbMultiExplorer = function(opId, dataType, data) {
  2. var text="";
  3. var jsonList=eval("("+data+")");
  4. if(jsonList.length == 0){
  5. alert("无数据");
  6. }
  7. for(var key in jsonList){
  8. text+=jsonList[key]+"<br>";
  9. }
  10. alert(text);
  11. }

cbWriteFile 写文件的回调方法

uexFileMgr.cbWriteFile(opCode,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opCode Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 0- 成功 1-失败

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbWriteFile = function(opCode,dataType,data) {
  2. alert(data);
  3. }

cbReadFile 读文件的回调方法

uexFileMgr.cbReadFile(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的内容

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbReadFile = function(opId, dataType, data) {
  2. alert(data);
  3. }

cbGetFileSize 获取文件大小的回调方法

uexFileMgr.cbGetFileSize(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的大小

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFileSize = function(opId, dataType, data) {
  2. alert("文件长度:" + data);
  3. }

cbGetFilePath 获取文件路径的回调方法

uexFileMgr.cbGetFilePath(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的路径

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFilePath = function(opId, dataType, data) {
  2. alert("文件路径:" + data);
  3. }

cbGetFileRealPath 获取文件实际路径的回调方法

uexFileMgr.cbGetFileRealPath(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的真实路径

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFileRealPath = function(opId, dataType, data) {
  2. alert("文件的真实路径:" + data);
  3. }

cbGetReaderOffset 获取文件偏移值的回调方法

uexFileMgr.cbGetReaderOffset(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的偏移量

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetReaderOffset=function(opId,dataType,data){
  2. alert(data);
  3. }

cbReadPercent 读百分比对应位置的字符的回调方法

uexFileMgr.cbReadPercent(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的内容

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbReadPercent =function(opId,dataType,data){
  2. alert(data);
  3. }

cbReadNext 读取下一页字符的回调方法

uexFileMgr.cbReadNext(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的内容

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbReadNext = function(opId,dataType,data){
  2. alert(data);
  3. }

cbReadtextarea 读取上一页字符的回调方法

uexFileMgr.cbReadtextarea(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回文件的内容

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbReadtextarea = function(opId,dataType,data){
  2. alert(data);
  3. }

cbOpenSecure 使用密码打开文件的回调方法

uexFileMgr.cbOpenSecure(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或者uex.cFailed,详见CONSTANT中Callbackint类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbOpenSecure = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert(opId+"打开加密文件成功");
  4. } else {
  5. alert(opId+"打开加密文件失败");
  6. }
  7. }

cbCreateSecure 使用密码创建文件的回调方法

uexFileMgr.cbCreateSecure(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或者uex.cFailed,详见CONSTANT中Callbackint类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbCreateSecure = function(opId, dataType, data) {
  2. if (data == 0) {
  3. alert("创建加密文件成功");
  4. } else {
  5. alert("创建加密文件失败");
  6. }
  7. }

cbGetFileCreateTime 使用获取文件或文件夹创建时间的回调方法

uexFileMgr.cbGetFileCreateTime(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 唯一标识符
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data String 返回创建时间

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexFileMgr.cbGetFileCreateTime = function(opId,dataType,data){
  2. alert(data);
  3. };

cbRenameFile 重命名文件的回调方法

uexFileMgr.cbRenameFile(param)

说明:

重命名文件的回调方法

参数:

参数名称 参数类型 是否必选 说明
param String param是字典结构json字符串,详情见下
  1. var param = {
  2. result:,//String,必选 重命名结果 "0" 失败 "1" 成功
  3. }

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.9+
Androd 3.0.4+

示例:

  1. uexFileMgr.cbRenameFile=function (info){
  2. alert(info);
  3. }

cbSearch 搜索文件的回调方法

uexFileMgr.cbSearch(param)

说明:

搜索文件的回调方法

参数:

参数名称 参数类型 是否必选 说明
param String param是字典结构json字符串,详情见下
  1. var param = {
  2. isSuccess:,//true false
  3. result:[],//文件路径数组
  4. }
  • 文件名规则

    • 如果是文件,传完整文件名,比如:”1.txt”
    • 如果是文件夹,则以”/“结尾,比如:”dir/“
  • 文件路径规则

    • 如果在目标文件夹下 传”文件名” 比如”1.txt”
    • 如果在其子文件夹下 传”/子文件夹1/子文件夹2/…/文件名” 比如:”dir/1.txt” “dir/dir2/“

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.12+
Android 3.0.10+

示例:

  1. uexFileMgr.cbSearch=function (info){
  2. alert(info);
  3. }

cbGetFileListByPath 获取某路径下的所有文件的回调方法

uexFileMgr.cbGetFileListByPath(opId, dataType, data)

说明:

获取某路径下的所有文件的回调方法

参数:

参数名称 参数类型 是否必选 说明
opId Number 操作Id
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Json 文件列表数据,如下:
  1. var data = [
  2. {
  3. fileName:,
  4. fileType:,
  5. filePath:
  6. }
  7. ]

各字段含义如下:

字段名称 类型 是否必选 说明
fileName String 文件名称
fileType Number 类型,0-表示文件,1-表示文件夹
filePath String 当前文件路径

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.13+
Android 3.0.6+

示例:

  1. uexFileMgr.cbGetFileListByPath=function (opId, dataType, info){
  2. alert(info);
  3. }

cbGetFileSizeByPath 通过路径获取文件大小的回调方法

uexFileMgr.cbGetFileSizeByPath(params)

说明:

通过路径获取文件大小的回调方法

参数:

  1. var params = {
  2. errorCode:,
  3. id:,
  4. data:,
  5. unit:
  6. }

各字段含义如下:

字段名称 类型 是否必选 说明
errorCode Number 状态码,0表示获取成功,非0表示失败,详情参考errorCode
id String 唯一标识符,errorCode不等于-1时,必选
data String 文件大小数据,errorCode为0时返回
unit String 文件大小单位,errorCode为0时返回,详情参考unit

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.17+
Android 3.0.12+

示例:

  1. uexFileMgr.cbGetFileSizeByPath=function(info){
  2. alert(info);
  3. }

cbCopyFile 复制单个文件的回调方法

uexFileMgr.cbCopyFile(opCode, dataType, data)

说明:

重命名文件的回调方法

参数:

参数名称 参数类型 是否必选 说明
opCode String 复制文件任务id
dataType Number 参数类型详见CONTANT中Callback方法数据类型
data Number 返回uex.cSuccess或者uex.cFailed,详见CONSTANT中Callbackint类型数据

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS 3.0.22+
Androd 3.0.13+

示例:

  1. uexFileMgr.cbCopyFile = function(opCode, dataType, data){
  2. alert("opCode:"+opCode+",dataType:"+dataType+",data"+data);
  3. }

3、更新历史

iOS

API版本:uexFileMgr-3.0.26

最近更新时间:2016-7-5

历史发布版本 更新内容
3.0.26 修复readFile被错误转义的问题
3.0.25 添加base64支持
3.0.24 改用bundle方式引用资源,修复IDE插件文件浏览器图标丢失的bug
3.0.23 修改工程为ARC;修复在复用窗口中使用时回调丢失的bug
3.0.22 新增copyFile接口
3.0.21 新增getFileSizeByPath接口
3.0.20 修改能够直接返回到应用程序界面,而不能通过该页面返回到附件的父目录下
3.0.19 添加IDE支持
3.0.18 删除info.plist
3.0.17 添加国际化支持
3.0.16 getFileListByPath不再返回其子目录下的文件路径
3.0.15 修复pptx和xlsx没有图标的问题
3.0.14 getFileRealPath可以设定回调方法
3.0.13 新增getFileListByPath
3.0.12 新增方法uexFileMgr.search 搜索文件
3.0.11 新增cbWriteFile回调方法,优化RC4加密
3.0.10 解决多选文件打开浏览器显示空白问题
3.0.9 新增方法uexFileMgr.renameFile 重命名文件
3.0.8 修复uexFileMgr.multiExplorer(path)中path参数无效的BUG
3.0.7 修改创建时间接口的名称
3.0.6 增加获取文件创建时间的新接口
3.0.5 修改8.0以上系统崩溃问题
3.0.4 适配文件浏览器横屏
3.0.3 修复文件单选浏览器,文件多时无法滑动到底的BUG; 修复单选和多选浏览器状态栏标题不一致问题
3.0.2 修复uexFileMgr.seekFile方法指定位置后 uexFileMgr.readNext方法还是从头读取的BUG
3.0.1 修复选择本地照片崩溃的bug
3.0.0 文件管理功能插件

Android

API版本:uexFileMgr-3.0.21

最近更新时间:2016-5-17

历史发布版本 更新内容
3.0.21 修正图片以Base64写入后打开失败的问题
3.0.20 修正部分成功失败的状态回调返回的回调数据类型错误的问题
3.0.19 修正readFile接口的option参数可以为空
3.0.18 修复多选文件时会导致显示选择数量不正确的问题
3.0.17 支持Base64读写
3.0.16 修复拒绝服务漏洞的问题
3.0.15 修改对文件的各种操作的opId支持非纯数字(与IOS保持一致)
3.0.14 修正getFileRealPath获取plugin子应用路径错误的问题
3.0.13 新增复制文件的方法
3.0.12 新增通过路径获取文件大小方法
3.0.11 修改getFileRealPath指定回调名时,只回调一个参数(与ios统一)。
3.0.10 新增文件搜索接口
3.0.9 修复闪退的bug
3.0.8 国际化
3.0.7 修改接口getFileRealPath,支持回调方法名称的传入
3.0.6 新增getFileListByPath方法获取指定目录中的文件列表
3.0.5 新增cbWriteFile回调方法
3.0.4 添加重命名接口
3.0.3 修复解析res://路径的getFileRealPath方法返回错误问题
3.0.2 修复res://协议下获取真实路径不正确的问题
3.0.1 新增获取文件或文件夹的创建时间
3.0.0 文件管理功能插件

4、附录

GetFileSizeErrorCode

errorCode 说明
0 获取成功
-1 无参数错误
-2 当前路径文件或文件夹不存在
-3 未知错误

GetFileSizeUnit

value 说明
B 字节
KB 1KB = 1024B
MB 1MB = 1024KB
GB 1GB = 1024MB