bui.file Class
文件管理,主要用于对下载文件的管理,安卓适用,web不支持
预览地址: demo
所有文件及文件夹的操作都基于根应用文件夹
getFolder: 获取创建文件夹removeFolder: 删除文件夹包含里面的所有文件
getFile: 获取创建文件
removeFile: 删除单个文件
getFileName: 返回路径的文件名
open: 打开文件
Constructor
bui.file
(
-
[option]
Parameters:
-
[option]Object optional-
[native] [ 1.5.1废弃,由needNative决定 <del>默认true 由bui.isWebapp状态决定 false则强制采用web方式</del>]Boolean optional -
[needNative] [ 1.5.1新增, 是否使用原生上传, 不受bui.isWebapp状态决定 默认 false|true 通过这个切换对应的效果,可以通过全局配置 bui.config.file= {needNative:true}]Boolean optional -
[size] [ 默认10 M存储的大小, WEB存储需要]Number optional
-
Example:
js:
var uiFile = bui.file();
// 创建 download 文件夹下的 bui.docx 文件
uiFile.getFile({
folderName: "download",
fileName: "bui.docx",
onSuccess: function (aa) {
bui.alert(aa)
},
onFail: function (err) {
bui.alert(err)
}
})
Item Index
Methods
getFile
(
chainable
-
[option] [] -
[option.fileName] [ 文件名称 需要带后缀名] -
[option.folderName] [ 文件夹名称, 创建子文件夹 download/image] -
[option.create] [是否创建文件 默认 false | true] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
获取文件或者创建文件
Parameters:
-
[option] []Object optional -
[option.fileName] [ 文件名称 需要带后缀名]String optional -
[option.folderName] [ 文件夹名称, 创建子文件夹 download/image]String optional -
[option.create] [是否创建文件 默认 false | true]Boolean optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
uiFile.getFile({
fileName: "bui.docx",
folderName: "download",
onSuccess: function(){
// this 指向 uiFile
console.log(this);
}
})
getFileName
(
-
name
获取文件名
Parameters:
-
nameString[ url地址, 例如: file:开头,http开头 ]
Example:
var name = uiFile.getFileName("file://bui.debug/bui.jpg?id=abcd");
// name = bui.jpg
getFolder
(
chainable
-
[option] [] -
[option.folderName] [ 文件夹名称, 创建子文件夹 download/image] -
[option.create] [是否创建文件夹 默认 false | true] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
获取文件夹或者创建文件夹
Parameters:
-
[option] []Object optional -
[option.folderName] [ 文件夹名称, 创建子文件夹 download/image]String optional -
[option.create] [是否创建文件夹 默认 false | true]Boolean optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
// 创建download文件夹
uiFile.getFolder({
folderName: "download",
create: true
})
open
(
chainable
-
[option] [] -
[option.url] [ 文件路径,一般是通过getFile得到的路径] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
本地程序打开文件, web不支持
Parameters:
-
[option] []Object optional -
[option.url] [ 文件路径,一般是通过getFile得到的路径]String optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
uiFile.open({
url: "file://",
onSuccess: function(url){
// 文件的地址
console.log(url)
}
})
removeFile
(
chainable
-
[option] [] -
[option.fileName] [ 文件名称,] -
[option.folderName] [ 哪个文件夹下的文件] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
删除文件,谨慎使用
Parameters:
-
[option] []Object optional -
[option.fileName] [ 文件名称,]String optional -
[option.folderName] [ 哪个文件夹下的文件]String optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
// 会包含文件夹所有的文件, 谨慎使用
uiFile.removeFile({
fileName: "bui.docx",
folderName: "download"
})
removeFolder
(
chainable
-
[option] [] -
[option.folderName] [ 文件夹名称] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
删除文件夹及里面所有文件,谨慎使用
Parameters:
-
[option] []Object optional -
[option.folderName] [ 文件夹名称]String optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
// 会包含文件夹所有的文件, 谨慎使用
uiFile.removeFolder({
folderName: "download"
})
toBase64
(
chainable
-
[option] [] -
[option.data] [ 通过getFile得到的文件] -
[option.onSuccess] [成功的回调] -
[option.onFail] [失败的回调]
把选择的图片文件转换成base64地址,可以直接展示在页面上
Parameters:
-
[option] []Object optional -
[option.data] [ 通过getFile得到的文件]String optional -
[option.onSuccess] [成功的回调]Function optional -
[option.onFail] [失败的回调]Function optional
Example:
uiFile.toBase64({
data: "file:///", //本地图片路径
onSuccess: function (imgurl) {
$("#id").append('<img src="'+imgurl+'" />')
}
});
widget
(
-
[name] [ 依赖控件名 fileselect]
获取依赖的控件
Parameters:
-
[name] [ 依赖控件名 fileselect]String optional
Example:
//获取依赖控件
var uiFileSelect = uiFile.widget("fileselect");
//使用uifileselect的方法
uiFileSelect.add({
onSuccess: function(data){
console.log(data);
}
});