IO模块管理本地文件系统,用于对文件系统的目录浏览、文件的读取、文件的写入等操作。通过plus.io可获取文件系统管理对象。
permissions
"File": { "description": "访问本地文件系统" }
文件系统中的目录对象,用于管理特定的本地目录
读取目录信息对象,用于获取目录中包含的文件及子目录
文件系统中的文件数据对象,用于获取文件的数据
文件系统中的文件对象,用于管理特定的本地文件
文件系统中的读取文件对象,用于获取文件的内容
FileReader对象是从设备文件系统读取文件FileReader对象是从设备文件系统读取文件的一种方式,文件以文本或者Base64编码的字符串形式读出来。 用户注册自己的事件监听器来接收loadstart、progress、load、loadend、error和abort事件。
文件系统中的写文件对象,用于写入文件内容
FileWriter对象是从设备文件系统写入文件FileWriter对象是从设备文件系统写入文件的一种方式,用户注册自己的事件监听器来接收writestart、progress、write、writeend、error和abort事件。 一个FileWriter对象是为单个文件的操作而创建。你可以使用该对象多次对相应文件进行写入操作。FileWriter维护该文件的指针位置及长度属性,这样你就可以寻找和写入文件的任何地方。 默认情况下,FileWriter从文件的开头开始写入(将覆盖现有数据)。FileWriter对象的seek方法可设置文件操作指定位置,如fw.seek(fw.length-1)写入操作就会从文件的末尾开始。
文件系统对象,用于管理特定本地文件目录
文件系统对象表示一个应用可访问的根目录。name属性用于标识此根目录的名称,与LocalFileSystem中的文件系统类型一一对应。root属性为文件目录对象,用于实际操作文件系统,参考DirectoryEntry。
JSON对象,获取文件操作的参数
指示如果文件或目录不存在时是否进行创建,默认值为false。
其本身没有任何效果,需与create属性值设置为true时一起使用,如果目标文件或目录已经存在则会导致文件或目录打开失败,默认值为false。
JSON对象,保存文件或目录的状态信息对象
可通过DirectoryEntry或FileEntry对象的getMetaData方法获取
若获取的是目录对象的属性则值为0。
若自身是文件则其值为0。
若自身是文件则其值为0。
文件或目录操作事件对象
所有文件或目录操作事件回调函数中都创建该对象的实例。 该对象从DOMEvent继承而来,可通过该其target属性获取事件触发的文件或目录操作对象。
在不同的回调中指向的对象不同,可指向的对象包括:FileEntry、DirectoryEntry、FileReader、FileWriter。
文件路径类型
在文件系统中的文件路径需转换成URL格式,已方便runtime快速加载。
相对路径URL
只能在扩展API中使用,相对于基座提供的特定目录,以“_”开头。
保存应用的所有html、css、js等资源文件,与文件系统中根目录PRIVATE_WWW,如“_www/res/icon.png”。
用于保存应用运行期业务逻辑数据,与文件系统中根目录PRIVATE_DOCUMENTS,如“_doc/userdata.xml”。
用于保存程序中各应用间可共享文件的目录,与文件系统中根目录PUBLIC_DOCUMENTS,如“_document/share.doc”。
用于保存程序下载文件的目录,与文件系统中根目录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对象的事件函数中触发。
请求文件系统成功的回调函数
void onSuccess( fs ) { // File System operate code. }
通过URL参数获取目录或文件对象成功的回调函数
void onSuccess( entry ) { // File or Direcory entry operate code. }
获取文件或目录状态信息成功的回调函数
void onSuccess( metadata ) { // Metadata code. }
操作文件或目录对象成功的回调函数
void onSuccess( entry ) { // Entry code. }
操作文件或目录对象数组成功的回调函数
void onSuccess( entrys ) { // Entrys code. }
写文件操作成功的回调函数
void onSuccess( writer ) { // FileWriter code. }
文件操作成功的回调函数
void onSuccess( file ) { // file code. }
文件操作失败的回调函数
void onError( error ) { // Error code. }