在线html5 api中文版,html5 api reference -凯发k8官方网
io模块管理本地文件系统，用于对文件系统的目录浏览、文件的读取、文件的写入等操作。通过plus.io可获取文件系统管理对象。
常量：
方法：
对象：
directoryentry: 文件系统中的目录对象，用于管理特定的本地目录
directoryreader: 读取目录信息对象，用于获取目录中包含的文件及子目录
file: 文件系统中的文件数据对象，用于获取文件的数据
fileentry: 文件系统中的文件对象，用于管理特定的本地文件
filereader: 文件系统中的读取文件对象，用于获取文件的内容
filewriter: 文件系统中的写文件对象，用于写入文件内容
filesystem: 文件系统对象，用于管理特定本地文件目录
flags: json对象，获取文件操作的参数
metadata: json对象，保存文件或目录的状态信息对象
fileevent: 文件或目录操作事件对象
urltype: 文件路径类型
localurl: 本地路径url
remoteurl: 网络路径url
回调方法：
模块：
5 功能模块(permissions)
{
// ...
"permissions":{
// ...
"file": {
"description": "文件系统"
}
}
}
应用运行资源目录常量
plus.io.private_www;
说明：
number
类型
本地文件系统常量，number类型，固定值1。应用运行资源目录，仅本应用可访问。
为了确保应用资源的安全性，此目录只可读。
平台支持
android - all (支持):
android平台应用资源是放到apk的assets目录中，安装到设备后无法枚举，为了能够正常枚举访问此目录，需要将应用设置为释放资源模式(在manifest.json中将runmode值设置为liberate)，这样程序在第一次运行时将资源释放到sdcard中。
通常在设备上的目录为“/sdcard/android/data/%packagename%/apps/%appid%/www”，其中%packagename%是程序的包名、%appid%是应用的标识，如“/sdcard/android/data/io.dcloud.helloh5/apps/helloh5/www”。
ios - all (支持):
ios平台应用资源是放到应用的沙盒目录中，安装到设备后放到应用沙盒目录的“/dcloud_pandora.app/pandora/apps/%appid%/www”，如“/dcloud_pandora.app/pandora/apps/hbuilder/www”。
如将应用设置为释放资源模式(在manifest.json中将runmode值设置为liberate)，程序在第一次运行时将资源释放到应用沙盒目录下的library中“/library/pandora/apps/%appid%/www”，如“/library/pandora/apps/hbuilder/www”。
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_www, function( fs ) {
// 可通过fs操作private_www文件系统
// ......
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
local file system
应用私有文档目录常量
plus.io.private_doc;
说明：
number
类型
本地文件系统常量，number类型，固定值2。应用私有文档目录，仅本应用可读写。
平台支持
android - all (支持):
通常在设备上的目录为“/sdcard/android/data/%packagename%/.%appid%/apps/%appid%/doc”，其中%packagename%是程序的包名、%appid%是应用的标识，如“/sdcard/android/data/io.dcloud.hbuilder/.hbuilder/apps/hbuilder/doc”。
ios - all (支持):
通常在设备应用沙盒目录下“/library/pandora/apps/%appid%/doc”，其中%appid%是应用的标识，，如“/library/pandora/apps/hbuilder/doc”。
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_doc, function( fs ) {
// 可通过fs操作private_doc文件系统
// ......
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
local file system
程序公用文档目录常量
plus.io.public_documents;
说明：
number
类型
本地文件系统常量，number类型，固定值3。程序公用文档目录，所有应用可读写。
平台支持
android - all (支持):
通常在设备上的目录为“/sdcard/android/data/%packagename%/.%appid%/documents”，其中%packagename%是程序的包名、%appid%是应用的标识，如“/sdcard/android/data/io.dcloud.hbuilder/.hbuilder/documents”。
ios - all (支持):
通常在设备应用沙盒目录下“/library/pandora/documents”。
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.public_documents, function( fs ) {
// 可通过fs操作public_documents文件系统
// ......
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
local file system
程序公用下载目录常量
plus.io.public_downloads;
说明：
number
类型
本地文件系统常量，number类型，固定值4。程序公用下载目录，所有应用可读写。
平台支持
android - all (支持):
通常在设备上的目录为“/sdcard/android/data/%packagename%/.%appid%/downloads”，其中%packagename%是程序的包名、%appid%是应用的标识，如“/sdcard/android/data/io.dcloud.hbuilder/.hbuilder/downloads”。
ios - all (支持):
通常在设备应用沙盒目录下“/library/pandora/downloads”。
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.public_downloads, function( fs ) {
// 可通过fs操作public_downloads文件系统
// ......
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
local file system
请求本地文件系统对象
void plus.io.requestfilesystem( type, succescb, errorcb );
说明：
获取指定的文件系统，可通过type指定获取文件系统的类型。
获取指定的文件系统对象成功通过succescb回调返回，失败则通过errorcb返回。
参数：
type:
(
number
)
必选本地文件系统常量
可取plus.io下的常量，如plus.io.private_doc、plus.io.public_documents等。
succescb:
errorcb:
返回值：
void
: 无
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_www, function( fs ) {
// 可通过fs进行文件操作
alert( "request file system success!" );
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
request file system
通过url参数获取目录对象或文件对象
void plus.io.resolvelocalfilesystem;
说明：
快速获取指定的目录或文件操作对象，如通过url值“_www/test.html”可直接获取文件操作对象。
url值可支持相对路径url、本地路径url、网络路径。
获取指定的文件或目录操作对象成功通过succescb回调返回，如果指定url路径或文件不存在则失败通过errorcb回调返回。
参数：
url :
(
domstring
)
必选要操作文件或目录的url地址
succescb:
errorcb:
返回值：
void
: 无
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.resolvelocalfilesystem {
// 可通过entry对象操作test.html文件
entry.file( function(file){
var filereader = new plus.io.filereader();
alert("getfile:" json.stringify(file));
filereader.readastext(file, 'utf-8');
filereader.onloadend = function(evt) {
alert("11" evt);
alert("evt.target" evt.target);
alert(evt.target.result);
}
alert(file.size '--' file.name);
} );
}, function ( e ) {
alert( "resolve file url failed: " e.message );
} );
}
request file system
将本地url路径转换成平台绝对路径
string plus.io.convertlocalfilesystem;
说明：
绝对路径符合各平台文件路径格式，通常用于native.js调用系统原生文件操作api，也可以在前面添加“file://”后在html页面中直接使用。
参数：
url:
(
string
)
必选要转换的文件或目录url地址
url地址必须是合法的路径，如果地址不合法则返回null。
返回值：
string
:
转换后在平台路径，在不同平台或者不同设备返回的值可能存在差异，如输入url为“_doc/a.png”：
android平台转换后的路径为“/storage/sdcard0/android/data/io.dcloud.hbuilder/.hbuilder/apps/hbuilder/doc/ａ.png”；
在ios平台转换后的路径为“/var/mobile/containers/data/application/757966cf-345c-4348-b07f-eef83cf9a369/library/pandora/apps/hbuilder/doc/a.png”。
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready(){
var url="_www/index.html";
var path=plus.io.convertlocalfilesystem;
alert(path);
}
convertlocalfilesystemurl
将平台绝对路径转换成本地url路径
string plus.io.convertabsolutefilesystem( path );
说明：
绝对路径符合各平台文件路径格式，转换后变成relativeurl类型格式。
功能与convertlocalfilesystemurl方法相反，将绝对路径转换成相对路径。
参数：
path:
(
string
)
必选要转换的平台绝对路径
绝对路径必须是合法的路径，如果绝对路径不合法则返回null。
返回值：
domstring
: 转换后本地url路径
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready(){
var url="_www/index.html";
var path=plus.io.convertlocalfilesystem;
var newurl = plus.io.convertabsolutefilesystem(path);
alert(newurl); // 显示值为“_www/index.html”
}
convertabsolutefilesystem
文件系统中的目录对象，用于管理特定的本地目录
属性：
isfile: 操作对象的是否为文件，directoryentry对象固定其值为false
isdirectory: 操作对象是否为目录，directoryentry对象固定其值为true
name: 目录操作对象的名称，不包括路径
fullpath: 目录操作对象的完整路径，文件系统的绝对路径
filesystem: 文件操作对象所属的文件系统对象，参考filesystem
方法：
moveto: 移动目录
copyto: 拷贝目录
tourl: 获取目录路径转换为url地址
tolocalurl: 获取目录路径转换为本地路径url地址
toremoteurl: 获取目录路径转换为网络路径url地址
remove: 删除目录
getparent: 获取目录所属的父目录
getfile: 创建或打开文件
操作对象的是否为文件，directoryentry对象固定其值为false
说明：
boolean
类型
只读属性
操作对象是否为目录，directoryentry对象固定其值为true
说明：
boolean
类型
只读属性
目录操作对象的名称，不包括路径
说明：
domstring
类型
只读属性
目录操作对象的完整路径，文件系统的绝对路径
说明：
domstring
类型
只读属性
文件操作对象所属的文件系统对象，参考filesystem
说明：
filesystem
类型
只读属性
获取目录的属性
entry.getmetadata( successcb, errorcb, recursive );
说明：
用于获取文件或目录的属性信息。
获取属性信息成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
recursive:
(
boolean
)
必选是否递归计算目录信息
true为递归计算获取信息，false不递归计算获取，默认值为false。
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// request the metadata object for this entry
entry.getmetadata( function ( metadata ) {
plus.console.log("last modified: " metadata.modificationtime);
}, function () {
alert( e.message );
} );
移动目录
entry.moveto( parent, newname, succescb, errorcb );
说明：
以下情况移动目录将会导致失败：
将父目录移动到子目录中；
要移动到的目标目录无效；
要移动到的目标路径被文件占用；
要移动到的目标目录已经存在并且不为空。
移动目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
parent:
newname:
(
domstring
)
可选移动后的目录名称，默认为原始目录名称
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
function movedirecty(srcentry,dstentry) {
var newname = document.getelementbyid('newname').value,
// move the directory to a new directory and rename it
srcentry.moveto( dstentry, newname, function( entry ) {
plus.console.log("new path: " entry.fullpath);
}, function ( e ) {
alert( e.message );
} );
}
拷贝目录
entry.copyto( parent, newname, succescb, errorcb );
说明：
以下情况拷贝目录将会导致失败：
将父目录拷贝到子目录中；
要拷贝到的目标目录无效；
要拷贝到的目标路径被文件占用；
要拷贝到的目标目录已经存在并且不为空。
拷贝目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
parent:
newname:
(
domstring
)
可选拷贝后的目录名称，默认为原始目录名称
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
function copydirecty(srcentry,dstentry){
var newname = document.getelementbyid('newname').value,
// copy the directory to a new directory and rename it
srcentry.copyto( dstentry, newname, function( entry ){
plus.console.log("new path: " entry.fullpath);
}, function( e ){
alert( e.message );
} );
}
获取目录路径转换为url地址
domstring entry.to;
参数：
返回值：
domstring
: 格式为相对路径url
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the url for this directory
var dirurl = entry.to;
plus.console.log(dirurl);
获取目录路径转换为本地路径url地址
domstring entry.tolocal;
参数：
返回值：
domstring
: 格式为本地路径url
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the local url for this directory
var dirurl = entry.tolocal;
plus.console.log(dirurl);
获取目录路径转换为网络路径url地址
domstring entry.toremote;
参数：
返回值：
domstring
:
url地址格式为以“http://localhost:13131/”开头的网络路径。
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the remote url for this directory
var dirurl = entry.toremote;
plus.console.log(dirurl);
删除目录
entry.remove( succescb, errorcb );
说明：
以下情况删除目录将会导致失败：
目录中存在文件；
删除根目录；
删除目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// remove this directory
entry.remove( function ( entry ) {
plus.console.log( "remove succeeded" );
}, function ( e ) {
alert( e.message );
} );
获取目录所属的父目录
entry.getparent( succescb, errorcb );
说明：
获取父目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the parent directoryentry
entry.getparent( function ( entry ) {
plus.console.log( "parent name: " entry.name );
}, function ( e ) {
alert( e.message );
} );
创建目录读取对象
directoryreader entry.createreader();
说明：
创建一个目录读取对象，用户读取目下的文件及子目录。
参数：
返回值：
directoryreader
: 目录读取对象
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// create a directory reader
var directoryreader = entry.createreader();
创建或打开子目录
entry.getdirectory( path, flag, succescb, errorcb );
说明：
创建或打开当前目录指定的目录。
创建或打开目录操作成功通过succescb回调返回，失败则通过errorcb返回。
参数：
path:
(
domstring
)
必选要操作目录相对于当前目录的地址
flag:
(
flags
)
可选要操作文件或目录的参数
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// retrieve an existing directory, or create it if it does not already exist
entry.getdirectory( "newdir", {create:true,exclusive:false}, function( dir ){
console.log("directory entry name: " dir.name);
}, function () {
alert( e.message );
} );
创建或打开文件
entry.getfile( path, flag, succescb, errorcb );
说明：
创建或打开当前目录下指定的文件。
创建或打开文件操作对象成功通过succescb回调返回，失败则通过errorcb返回。
参数：
path:
(
domstring
)
必选要操作文件相对于当前目录的地址
flag:
(
flags
)
可选要操作文件或目录的参数
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_www, function(fs){
// fs.root是根目录操作对象directoryentry
fs.root.getfile('config.xml',{create:true}, function(fileentry){
fileentry.file( function(file){
var filereader = new plus.io.filereader();
alert("getfile:" json.stringify(file));
filereader.readastext(file, 'utf-8');
filereader.onloadend = function(evt) {
alert("11" evt);
alert("evt.target" evt.target);
alert(evt.target.result);
}
alert(file.size '--' file.name);
} );
});
} );
}
request file system
递归删除目录
entry.removerecursively( succescb, errorcb );
说明：
删除目录将会删除其下的所有文件及子目录
不能删除根目录，如果操作删除根目录将会删除目录下的文件及子目录，不会删除根目录自身。
删除目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// remove the directory and all it's contents
entry.removerecursively( function ( entry ) {
plus.console.log( "remove recursively succeeded" );
}, function ( e ) {
alert( e.message );
} );
读取目录信息对象，用于获取目录中包含的文件及子目录
方法：
readentries: 获取当前目录中的所有文件和子目录
获取当前目录中的所有文件和子目录
directoryreader.readentries( succescb, errorcb );
说明：
获取当前目录下的所有文件和子目录。
获取操作成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_www, function(fs){
// fs.root是根目录操作对象directoryentry
// 创建读取目录信息对象
var directoryreader = fs.root.createreader();
directoryreader.readentries( function( entries ){
var i;
for( i=0; i < entries.length; i ) {
alert( entries[i].name );
}
}, function ( e ) {
alert( "read entries failed: " e.message );
} );
} );
}
request file system
文件系统中的文件数据对象，用于获取文件的数据
属性：
size: 文件数据对象的数据大小，单位为字节
type: 文件数据对象mime类型
name: 文件数据对象的名称，不包括路径
方法：
slice: 获取文件指定的数据内容
close: 关闭文件数据对象
文件数据对象的数据大小，单位为字节
说明：
number
类型
只读属性
文件数据对象mime类型
说明：
domstring
类型
只读属性
文件数据对象的名称，不包括路径
说明：
domstring
类型
只读属性
文件对象的最后修改时间
说明：
date
类型
只读属性
获取文件指定的数据内容
file.slice( start, end );
说明：
获取文件指定的数据内容，其中end必须大于start。
参数：
start:
(
number
)
可选获取文件数据的其实位置
end:
(
number
)
可选获取文件数据的结束位置
返回值：
file
: 指定数据内容的文件对象
示例：
var slice1 = file.slice(100, 400);
var slice2 = slice1.slice(20, 35);
var slice3 = file.slice(120, 135);
// slice2 and slice3 are equivalent.
关闭文件数据对象
file.close();
说明：
当文件数据对象不再使用时，可通过此方法关闭，释放系统资源。
参数：
返回值：
void
: 无
示例：
var slice1 = file.slice(100, 400);
var slice2 = slice1.slice(20, 35);
var slice3 = file.slice(120, 135);
// slice2 and slice3 are equivalent.
// ......
slice3.close();
文件系统中的文件对象，用于管理特定的本地文件
属性：
isfile: 文件操作对象的是否为文件，fileentry对象固定其值为true
isdirectory: 文件操作对象是否为目录，fileentry对象固定其值为false
name: 文件操作对象的名称，不包括路径
fullpath: 文件操作对象的完整路径，文件系统的绝对路径
filesystem: 文件操作对象所属的文件系统对象，参考filesystem
方法：
getmetadata: 获取文件的属性信息
moveto: 移动文件
copyto: 拷贝文件
tourl: 获取文件路径转换为url地址
tolocalurl: 获取文件路径转换为本地路径url地址
toremoteurl: 获取文件路径转换为网络路径url地址
remove: 删除文件
getparent: 获取文件所属的父目录
createwriter: 获取文件关联的写文件操作对象filewriter
file: 获取文件数据对象
文件操作对象的是否为文件，fileentry对象固定其值为true
说明：
boolean
类型
只读属性
文件操作对象是否为目录，fileentry对象固定其值为false
说明：
boolean
类型
只读属性
文件操作对象的名称，不包括路径
说明：
domstring
类型
只读属性
文件操作对象的完整路径，文件系统的绝对路径
说明：
domstring
类型
只读属性
文件操作对象所属的文件系统对象，参考filesystem
说明：
获取文件的属性信息
entry.getmetadata( successcb, errorcb );
说明：
用于获取文件的属性信息。
获取属性信息成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// request the metadata object for this entry
entry.getmetadata( function ( metadata ) {
plus.console.log("last modified: " metadata.modificationtime);
}, function () {
alert( e.message );
} );
移动文件
entry.moveto( parent, newname, succescb, errorcb );
说明：
以下情况移动目录将会导致失败：
要移动到的目标目录无效；
要移动到的目标路径被其它文件占用；
移动文件成功通过succescb回调返回，失败则通过errorcb返回。
参数：
parent:
newname:
(
domstring
)
可选移动后的文件名称，默认为原始文件名称
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
function movefile(fileentry,dstentry){
// move the file to a new directory and rename it
fileentry.moveto( dstentry, "newfile.txt", function( entry ){
plus.console.log("new path: " entry.fullpath);
}, function( e ){
alert( e.message );
} );
}
拷贝文件
entry.copyto( parent, newname, succescb, errorcb );
说明：
以下情况拷贝文件将会导致失败：
要拷贝到的目标目录无效；
要拷贝到的目标路径被其它文件占用；
拷贝文件成功通过succescb回调返回，失败则通过errorcb返回。
参数：
parent:
newname:
(
domstring
)
可选拷贝后的文件名称，默认为原始文件名称
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
function copyfile(fileentry,dstentry) {
// copy the file to a new directory and rename it
fileentry.copyto( dstentry, "file.copy", function( entry ){
plus.console.log("new path: " entry.fullpath);
}, function( e ){
alert( e.message );
} );
}
获取文件路径转换为url地址
domstring entry.to;
参数：
返回值：
domstring
: 格式为相对路径url
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the url for this file
var fileurl = entry.to;
plus.console.log(fileurl);
获取文件路径转换为本地路径url地址
domstring entry.tolocal;
参数：
返回值：
domstring
: 格式为本地路径url
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the local url for this file
var fileurl = entry.tolocal;
plus.console.log(dirurl);
获取文件路径转换为网络路径url地址
domstring entry.toremote;
说明：
url地址格式为以“http://localhost:13131/”开头的网络路径。
参数：
无
返回值：
domstring
: 网络格式路径url
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the remote url for this file
var fileurl = entry.toremote;
plus.console.log(dirurl);
删除文件
entry.remove( succescb, errorcb );
说明：
删除文件成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// remove this file
entry.remove( function ( entry ) {
plus.console.log( "remove succeeded" );
}, function ( e ) {
alert( e.message );
} );
获取文件所属的父目录
entry.getparent( succescb, errorcb );
说明：
获取父目录成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the parent directoryentry
entry.getparent( function ( entry ) {
plus.console.log( "parent name: " entry.name );
}, function ( e ) {
alert( e.message );
} );
获取文件关联的写文件操作对象filewriter
entry.createwriter( succescb, errorcb );
说明：
获取写文件操作对象成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// create a filewriter to write to the file
entry.createwriter( function ( writer ) {
// write data to file.
writer.write( "data " );
}, function ( e ) {
alert( e.message );
} );
获取文件数据对象
entry.file( succescb, errorcb );
说明：
获取文件数据对象成功通过succescb回调返回，失败则通过errorcb返回。
参数：
succescb:
errorcb:
返回值：
void
: 无
平台支持：
android - 2.2 (支持)
ios - 4.3 (支持)
示例：
// get the parent directoryentry
entry.file( function ( file ) {
plus.console.log("file size: " file.size);
}, function ( e ) {
alert( e.message );
} );
文件系统中的读取文件对象，用于获取文件的内容
说明：
filereader对象是从设备文件系统读取文件filereader对象是从设备文件系统读取文件的一种方式，文件以文本或者base64编码的字符串形式读出来。
用户注册自己的事件监听器来接收loadstart、progress、load、loadend、error和abort事件。
构造：
filereader: 创建读取文件对象
常量：
empty: 值为0，开始读取文件状态
loading: 值为1，正在读取文件状态
done: 值为2，读文件操作完成状态
属性：
readystate: 当前读取文件所处的状态
result: 已读取文件的内容
error: 文件操作错误代码
方法：
abort: 终止文件读取操作
readasdataurl: 以url编码格式读取文件数据内容
readastext: 以文本格式读取文件数据内容
事件：
onloadstart: 读取文件开始时的回调函数
onprogress: 读取文件过程中的回调函数
onload: 读取文件成功完成的回调函数
onabort: 取消读取文件时的回调函数
onerror: 文件读取操作失败时调用的回调函数
onloadend: 文件读取操作完成时的回调函数
创建读取文件对象
说明：
创建读取文件对象
参数：
无
返回值：
filereader
:
值为0，开始读取文件状态
说明：
number
类型
值为1，正在读取文件状态
说明：
number
类型
值为2，读文件操作完成状态
说明：
number
类型
当前读取文件所处的状态
说明：
number
类型
只读属性
可取上面定义的常量值，empty(0)、loading(1)、done(2)。
已读取文件的内容
说明：
domstring
类型
只读属性
文件操作错误代码
说明：
number
类型
只读属性
终止文件读取操作
reader.abort();
说明：
读取文件操作开始后，可通过此方法取消读取文件。
调用此方法后将触发文件读取对象的onabort事件。
参数：
返回值：
void
: 无
示例：
// read data from file
var reader = null;
entry.file( function ( file ) {
reader = new plus.io.filereader();
reader.onloadend = function ( e ) {
plus.console.log( "read success" );
// get data
plus.console.log( e.target.result );
};
reader.readastext( file );
}, function ( e ) {
alert( e.message );
} );
// ......
// abort read data from file
reader.abort();
以url编码格式读取文件数据内容
reader.readasdata;
说明：
读取文件的数据内容，并将数据内容进行url编码。
参数：
file:
(
file
)
必选要读取的文件数据对象
encoding :
(
domstring
)
可选读取文件数据内容的字符编码格式
目前仅支持utf-8编码格式。
返回值：
void
: 无
示例：
// read data from file
var reader = null;
entry.file( function ( file ) {
reader = new plus.io.filereader();
reader.onloadend = function ( e ) {
plus.console.log( "read success" );
// get data
plus.console.log( e.target.result );
};
reader.readasdata;
}, function ( e ) {
alert( e.message );
} );
以文本格式读取文件数据内容
reader.readastext( file, encoding );
说明：
读取文件的数据内容。
参数：
file:
(
file
)
必选要读取的文件数据对象
encoding :
(
domstring
)
可选读取文件数据内容的字符编码格式
目前仅支持utf-8编码格式。
返回值：
void
: 无
示例：
// read data from file
var reader = null;
entry.file( function ( file ) {
reader = new plus.io.filereader();
reader.onloadend = function ( e ) {
plus.console.log( "read success" );
// get data
plus.console.log( e.target.result );
};
reader.readastext( file );
}, function ( e ) {
alert( e.message );
} );
读取文件开始时的回调函数
说明：
读取文件过程中的回调函数
说明：
用于获取文件读取进度。
读取文件成功完成的回调函数
说明：
取消读取文件时的回调函数
说明：
文件读取操作失败时调用的回调函数
说明：
文件读取操作完成时的回调函数
说明：
不管成功或失败都会触发。
文件系统中的写文件对象，用于写入文件内容
说明：
filewriter对象是从设备文件系统写入文件filewriter对象是从设备文件系统写入文件的一种方式，用户注册自己的事件监听器来接收writestart、progress、write、writeend、error和abort事件。
一个filewriter对象是为单个文件的操作而创建。你可以使用该对象多次对相应文件进行写入操作。filewriter维护该文件的指针位置及长度属性，这样你就可以寻找和写入文件的任何地方。
默认情况下，filewriter从文件的开头开始写入(将覆盖现有数据)。filewriter对象的seek方法可设置文件操作指定位置，如fw.seek(fw.length-1)写入操作就会从文件的末尾开始。
常量：
init: 值为0，写文件初始化状态
writing: 值为1，正在写入文件状态
done: 值为2，写文件操作完成状态
属性：
readystate: 当前写入文件所处的状态
length: 文件当前的长度，单位为字节
position: 文件当前操作的指针位置
error: 文件写入操作错误代码
方法：
abort: 终止文件写入操作
seek: 定位文件操作位置
truncate: 按照指定长度截断文件
write: 向文件中写入数据
事件：
onwritestart: 写入文件开始时的回调函数
onprogress: 写入文件过程中的回调函数
onwrite: 写入文件成功完成的回调函数
onabort: 取消写入文件时的回调函数
onerror: 文件写入操作失败时调用的回调函数
onwriteend: 文件写入操作完成时的回调函数
值为0，写文件初始化状态
说明：
number
类型
值为1，正在写入文件状态
说明：
number
类型
值为2，写文件操作完成状态
说明：
number
类型
当前写入文件所处的状态
说明：
number
类型
只读属性
可取上面定义的常量值，init(0)、writing(1)、done(2)。
文件当前的长度，单位为字节
说明：
number
类型
只读属性
文件当前操作的指针位置
说明：
number
类型
只读属性
文件写入操作错误代码
说明：
number
类型
只读属性
终止文件写入操作
writer.abort();
说明：
写入文件数据操作开始后，可通过此方法取消写入文件数据操作。
调用此方法后将触发文件写入对象的onabort事件。
参数：
返回值：
void
: 无
示例：
// write data to file
var w = null;
entry.createwriter( function ( writer ) {
w = writer;
// fast forwards file pointer to end of file
writer.seek( writer.length-1 );
}, function ( e ) {
alert( e.message );
} );
// ......
// abort write data to file
w.abort();
定位文件操作位置
writer.seek( position );
说明：
定位文件的操作位置，有效值为0到文件的总长度减1。
0表示文件的起始位置。
参数：
position:
(
number
)
必选要定位到的位置
返回值：
void
: 无
示例：
// write data to file
var w = null;
entry.createwriter( function ( writer ) {
w = writer;
// fast forwards file pointer to end of file
writer.seek( writer.length-1 );
}, function ( e ) {
alert( e.message );
} );
按照指定长度截断文件
writer.truncate( length );
说明：
从文件当前定位的位置开始，按照指定长度截断文件。
参数：
length :
(
number
)
必选截断后的文件长度
返回值：
void
: 无
示例：
// truncate file
entry.createwriter( function ( writer ) {
// truncate file data length to 100
writer.truncate( 100 );
}, function ( e ) {
alert( e.message );
} );
向文件中写入数据
writer.write( data );
说明：
从文件当前定位的位置开始，写入数据到文件中。
如果文件中已经存在数据，新写入的数据将覆盖已有数据。
参数：
data :
(
domstring
)
必选要写入的数据内容
返回值：
void
: 无
示例：
// write data to file
entry.createwriter( function ( writer ) {
writer.onwrite = function ( e ) {
plus.console.log( "write data success!" );
};
// write data to the end of file.
writer.seek( writer.length );
writer.write( "new data!" );
}, function ( e ) {
alert( e.message );
} );
写入文件开始时的回调函数
说明：
写入文件过程中的回调函数
说明：
用于获取文件读取进度。
写入文件成功完成的回调函数
说明：
取消写入文件时的回调函数
说明：
文件写入操作失败时调用的回调函数
说明：
文件写入操作完成时的回调函数
说明：
不管成功或失败都会触发。
文件系统对象，用于管理特定本地文件目录
说明：
文件系统对象表示一个应用可访问的根目录。name属性用于标识此根目录的名称，与localfilesystem中的文件系统类型一一对应。root属性为文件目录对象，用于实际操作文件系统，参考directoryentry。
属性：
name: 文件系统的名称
root: 文件系统的根目录
示例：
file example// 扩展api加载完毕后调用onplusready回调函数
document.addeventlistener( "plusready", onplusready, false );
// 扩展api加载完毕，现在可以正常调用扩展api
function onplusready() {
plus.io.requestfilesystem( plus.io.private_www, function( fs ) {
// 可通过fs进行文件操作
alert( "file system name: " fs.name );
// 通过fs.root获取directoryentry对象进行操作
// fs.root
}, function ( e ) {
alert( "request file system failed: " e.message );
} );
}
request file system
文件系统的名称
说明：
domstring
类型
只读属性
值为文件系统类型常量值字符串，如“private_www”、“private_documents”。
文件系统的根目录
说明：
json对象，获取文件操作的参数
属性：
create: (boolean
类型
)是否创建对象标记
指示如果文件或目录不存在时是否进行创建，默认值为false。
exclusive: (boolean
类型
)反向操作标记
其本身没有任何效果，需与create属性值设置为true时一起使用，如果目标文件或目录已经存在则会导致文件或目录打开失败，默认值为false。
json对象，保存文件或目录的状态信息对象
说明：
可通过directoryentry或fileentry对象的getmetadata方法获取
属性：
modificationtime: (date
类型
)文件或目录的最后修改时间
size: (number
类型
)文件的大小
若获取的是目录对象的属性则值为0。
directorycount: (number
类型
)包含的子目录数
若自身是文件则其值为0。
filecount: (number
类型
)目录的文件数
若自身是文件则其值为0。
文件或目录操作事件对象
说明：
所有文件或目录操作事件回调函数中都创建该对象的实例。
该对象从domevent继承而来，可通过该其target属性获取事件触发的文件或目录操作对象。
属性：
target:
在不同的回调中指向的对象不同，可指向的对象包括：fileentry、directoryentry、filereader、filewriter。
文件路径类型
说明：
在文件系统中的文件路径需转换成url格式，已方便runtime快速加载。
相对路径url
说明：
只能在扩展api中使用，相对于基座提供的特定目录，以“_”开头。
常量：
"_www": (domstring
类型
)应用资源目录
保存应用的所有html、css、js等资源文件，与文件系统中根目录private_www一致，后面加相对路径如“_www/res/icon.png”。
注意：应用资源目录是只读目录，只能读取次目录下的文件，不能修改或新建。
"_doc": (domstring
类型
)应用私有文档目录
用于保存应用运行期业务逻辑数据，与文件系统中根目录private_documents，如“_doc/userdata.xml”。
"_documents": (domstring
类型
)程序公用文档目录
用于保存程序中各应用间可共享文件的目录，与文件系统中根目录public_documents，如“_document/share.doc”。
"_downloads": (domstring
类型
)程序公用下载目录
用于保存程序下载文件的目录，与文件系统中根目录public_downloads，如“_download/mydoc.doc”。
本地路径url
说明：
可在html页面中直接访问本地资源，以“file:///”开头，后面跟随系统的绝对路径。
如示例：“file:///d:/res/hello.html”。
网络路径url
说明：
可在html页面中以网络资源模式访问本地资源，以“http://”开头，后面跟随相对路径。
如示例：“http://localhost:13131/_www/res/icon.png”，其中“_www”字段可支持类型与相对路径url一致。
文件事件回调
void onevent( event ) {
// event code.
}
说明：
文件或目录操作回调事件。
通常在filereader和filewriter对象的事件函数中触发。
参数：
event:
返回值：
void
: 无
请求文件系统成功的回调函数
void onsuccess( fs ) {
// file system operate code.
}
参数：
fs:
返回值：
void
: 无
通过url参数获取目录或文件对象成功的回调函数
void onsuccess( entry ) {
// file or direcory entry operate code.
}
参数：
entry:
返回值：
void
: 无
获取文件或目录状态信息成功的回调函数
void onsuccess( metadata ) {
// metadata code.
}
参数：
metadata:
返回值：
void
: 无
操作文件或目录对象成功的回调函数
void onsuccess( entry ) {
// entry code.
}
参数：
entry:
返回值：
void
: 无
操作文件或目录对象数组成功的回调函数
void onsuccess( entrys ) {
// entrys code.
}
参数：
entrys:
返回值：
void
: 无
写文件操作成功的回调函数
void onsuccess( writer ) {
// filewriter code.
}
参数：
writer:
返回值：
void
: 无
文件操作成功的回调函数
void onsuccess( file ) {
// file code.
}
参数：
file:
(
file
)
必选文件数据对象的引用
返回值：
void
: 无
文件操作失败的回调函数
void onerror( error ) {
// error code.
}
参数：
error:
(
domexception
)
必选文件操作失败的信息
返回值：
void
: 无
总结
以上是凯发k8官方网为你收集整理的在线html5 api中文版,html5 api reference的全部内容，希望文章能够帮你解决所遇到的问题。
- 上一篇：
- 下一篇：