为了安全管理应用的资源目录,规范对文件系统的操作,5+ API在系统应用目录的基础设计了应用沙盒目录, 分为私有目录和公共目录两种类型,私有目录仅应用自身可以访问,公共目录在多应用环境时(如小程序SDK)所有应用都可访问。
调用5+ API时通常需要传入文件路径,为了方便理解,分为以下类型:
常量:
方法:
对象:
回调方法:
权限:
5+功能模块(permissions)
PRIVATE_WWW
应用私有资源目录常量
说明:
Number 类型
本地文件系统常量,Number类型,固定值1,对应相对路径URL为"_www"开头的地址。 应用所有资源保存到此目录,仅本应用可访问。 为了确保应用资源的安全性,通常此目录只可读。
注意: 需要将应用设置为释放资源模式才能访问此目录,配置方法:
- uni-app项目,在manifest.json的"app-plus"节点下添加"runmode":"liberate"
- 5+ App项目,在manifest.json的"plus"节点下添加"runmode":"liberate"
提交云端打包生效,详见manifest.json的runmode配置
平台支持
- Android - ALL (支持) :
应用资源默认在apk的assets目录中,安装到设备后无法通过5+ API操作。 为了能够正常枚举访问此目录,需要将应用设置为释放资源模式(在manifest.json中将runmode值设置为liberate), 这样程序在第一次运行时将资源释放到应用Android系统应用内部存储目录(通常为“/storage/emulated/0/Android/data/%PACKAGENAME%/”,其中%PACKAGENAME%是程序的包名)下的 “apps%APPID%/www”,其中%APPID%是应用的标识。
- iOS - ALL (支持) :
应用资源默认在应用沙盒目录下的“/DCloud_Pandora.app/Pandora/apps/%APPID%/www”中, 如将应用设置为释放资源模式(在manifest.json中将runmode值设置为liberate),程序在第一次运行时将资源释放到iOS系统应用沙盒目录下的“/Library/Pandora/apps/%APPID%/www”, 其中%APPID%是应用的标识。
示例:
uni-app使用plus注意事项
PRIVATE_DOC
应用私有文档目录常量
说明:
Number 类型
本地文件系统常量,Number类型,固定值2,对应相对路径URL为"_doc"开头的地址。 应用私有文档目录,仅本应用可读写。
平台支持
示例:
uni-app使用plus注意事项
PUBLIC_DOCUMENTS
应用公共文档目录常量
说明:
Number 类型
本地文件系统常量,Number类型,固定值3,对应相对路径URL为"_documents"开头的地址。 安装包存在多个5+ App或uni-app环境时(如小程序SDK),所有5+ App或uni-app都可进行读写操作。
平台支持
- Android - ALL (支持) :
对应Android系统应用外部存储目录(通常为“/sdcard/Android/data/%PACKAGENAME%/”,其中%PACKAGENAME%是程序的包名)下的"documents"目录, 如HBuilder基座对应目录为“/sdcard/Android/data/io.dcloud.HBuilder/documents”。
- iOS - ALL (支持) :
对应iOS系统应用沙盒目录下的“/Library/Pandora/documents”。
示例:
uni-app使用plus注意事项
PUBLIC_DOWNLOADS
应用公共下载目录常量
说明:
Number 类型
本地文件系统常量,Number类型,固定值4,对应相对路径URL为"_downloads"开头的地址。 安装包存在多个5+ App或uni-app环境时(如小程序SDK),所有5+ App或uni-app都可进行读写操作。
平台支持
- Android - ALL (支持) :
对应Android系统应用外部存储目录(通常为“/sdcard/Android/data/%PACKAGENAME%/”,其中%PACKAGENAME%是程序的包名)下的"downloads"目录, 如HBuilder基座对应目录为“/sdcard/Android/data/io.dcloud.HBuilder/downloads”。
- iOS - ALL (支持) :
对应iOS系统应用沙盒目录下的“/Library/Pandora/downloads”。
示例:
uni-app使用plus注意事项
requestFileSystem
请求本地文件系统对象
说明:
获取指定的文件系统,可通过type指定获取文件系统的类型。 获取指定的文件系统对象成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
resolveLocalFileSystemURL
通过URL参数获取目录对象或文件对象
说明:
快速获取指定的目录或文件操作对象,如通过URL值“_www/test.html”可直接获取文件操作对象。 url值可支持相对路径URL、本地路径URL。 获取指定的文件或目录操作对象成功通过succesCB回调返回,如果指定URL路径或文件不存在则失败通过errorCB回调返回。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
convertLocalFileSystemURL
将本地URL路径转换成平台绝对路径
说明:
绝对路径符合各平台文件路径格式,通常用于Native.JS调用系统原生文件操作API,也可以在前面添加“file://”后在html页面中直接使用。
参数:
返回值:
String : 转换后在平台路径,在不同平台或者不同设备返回的值可能存在差异,如输入url为“_doc/a.png”: Android平台转换后的路径为“/storage/sdcard0/Android/data/io.dcloud.HBuilder/.HBuilder/apps/HBuilder/doc/a.png”; 在iOS平台转换后的路径为“/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png”。
示例:
uni-app使用plus注意事项
convertAbsoluteFileSystem
将平台绝对路径转换成本地URL路径
说明:
绝对路径符合各平台文件路径格式,转换后变成RelativeURL类型格式。 功能与convertLocalFileSystemURL方法相反,将绝对路径转换成相对路径。
参数:
返回值:
String : 转换后本地URL路径
示例:
uni-app使用plus注意事项
getAudioInfo
获取音频文件信息
说明:
仅支持获取本地音频文件信息。
参数:
options参数为json类型,包含以下属性:
返回值:
void : 无
getFileInfo
获取文件信息
说明:
支持获取本地文件信息。
参数:
options参数为json类型,包含以下属性:
返回值:
void : 无
getImageInfo
获取图片信息
说明:
支持获取本地图片和网络图片的信息。
参数:
options参数为json类型,包含以下属性:
返回值:
void : 无
getVideoInfo
获取视频文件信息
说明:
仅支持获取本地视频文件信息。
参数:
options参数为json类型,包含以下属性:
返回值:
void : 无
DirectoryEntry
文件系统中的目录对象,用于管理特定的本地目录
属性:
方法:
isFile
操作对象的是否为文件,DirectoryEntry对象固定其值为false
说明:
Boolean 类型 只读属性
isDirectory
操作对象是否为目录,DirectoryEntry对象固定其值为true
说明:
Boolean 类型 只读属性
name
目录操作对象的名称,不包括路径
说明:
String 类型 只读属性
fullPath
目录操作对象的完整路径,文件系统的绝对路径
说明:
String 类型 只读属性
fileSystem
文件操作对象所属的文件系统对象,参考FileSystem
说明:
FileSystem 类型 只读属性
getMetadata
获取目录的属性
说明:
用于获取文件或目录的属性信息。 获取属性信息成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
moveTo
移动目录
说明:
以下情况移动目录将会导致失败: 将父目录移动到子目录中; 要移动到的目标目录无效; 要移动到的目标路径被文件占用; 要移动到的目标目录已经存在并且不为空。 移动目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
copyTo
拷贝目录
说明:
以下情况拷贝目录将会导致失败: 将父目录拷贝到子目录中; 要拷贝到的目标目录无效; 要拷贝到的目标路径被文件占用; 要拷贝到的目标目录已经存在并且不为空。 拷贝目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toURL
获取目录路径转换为URL地址
参数:
返回值:
String : 格式为相对路径URL
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toLocalURL
获取目录路径转换为本地路径URL地址
参数:
返回值:
String : 格式为本地路径URL
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toRemoteURL
获取目录路径转换为网络路径URL地址
参数:
返回值:
String : URL地址格式为以“http://localhost:13131/”开头的网络路径。 注:仅用于网络页面访问本地资源,不推荐使用(将废弃)。
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
remove
删除目录
说明:
以下情况删除目录将会导致失败: 目录中存在文件; 删除根目录; 删除目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
getParent
获取目录所属的父目录
说明:
获取父目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
createReader
创建目录读取对象
说明:
创建一个目录读取对象,用户读取目下的文件及子目录。
参数:
返回值:
DirectoryReader : 目录读取对象
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
getDirectory
创建或打开子目录
说明:
创建或打开当前目录指定的目录。 创建或打开目录操作成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
getFile
创建或打开文件
说明:
创建或打开当前目录下指定的文件。 创建或打开文件操作对象成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
removeRecursively
递归删除目录
说明:
删除目录将会删除其下的所有文件及子目录 不能删除根目录,如果操作删除根目录将会删除目录下的文件及子目录,不会删除根目录自身。 删除目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
DirectoryReader
读取目录信息对象,用于获取目录中包含的文件及子目录
方法:
readEntries
获取当前目录中的所有文件和子目录
说明:
获取当前目录下的所有文件和子目录。 获取操作成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
File
文件系统中的文件数据对象,用于获取文件的数据
属性:
方法:
size
文件数据对象的数据大小,单位为字节
说明:
Number 类型 只读属性
type
文件数据对象MIME类型
说明:
String 类型 只读属性
name
文件数据对象的名称,不包括路径
说明:
String 类型 只读属性
lastModifiedDate
文件对象的最后修改时间
说明:
Date 类型 只读属性
slice
获取文件指定的数据内容
说明:
获取文件指定的数据内容,其中end必须大于start。
参数:
返回值:
File : 指定数据内容的文件对象
示例:
uni-app使用plus注意事项
close
关闭文件数据对象
说明:
当文件数据对象不再使用时,可通过此方法关闭,释放系统资源。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
FileEntry
文件系统中的文件对象,用于管理特定的本地文件
属性:
方法:
isFile
文件操作对象的是否为文件,FileEntry对象固定其值为true
说明:
Boolean 类型 只读属性
isDirectory
文件操作对象是否为目录,FileEntry对象固定其值为false
说明:
Boolean 类型 只读属性
name
文件操作对象的名称,不包括路径
说明:
String 类型 只读属性
fullPath
文件操作对象的完整路径,文件系统的绝对路径
说明:
String 类型 只读属性
fileSystem
文件操作对象所属的文件系统对象,参考FileSystem
说明:
FileSystem 类型 只读属性
getMetadata
获取文件的属性信息
说明:
用于获取文件的属性信息。 获取属性信息成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
moveTo
移动文件
说明:
以下情况移动目录将会导致失败: 要移动到的目标目录无效; 要移动到的目标路径被其它文件占用; 移动文件成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
copyTo
拷贝文件
说明:
以下情况拷贝文件将会导致失败: 要拷贝到的目标目录无效; 要拷贝到的目标路径被其它文件占用; 拷贝文件成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toURL
获取文件路径转换为URL地址
参数:
返回值:
String : 格式为相对路径URL
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toLocalURL
获取文件路径转换为本地路径URL地址
参数:
返回值:
String : 格式为本地路径URL
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
toRemoteURL
获取文件路径转换为网络路径URL地址
说明:
URL地址格式为以“http://localhost:13131/”开头的网络路径。
参数:
无
返回值:
String : 网络格式路径URL
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
remove
删除文件
说明:
删除文件成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
getParent
获取文件所属的父目录
说明:
获取父目录成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
createWriter
获取文件关联的写文件操作对象FileWriter
说明:
获取写文件操作对象成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
file
获取文件数据对象
说明:
获取文件数据对象成功通过succesCB回调返回,失败则通过errorCB返回。
参数:
返回值:
void : 无
平台支持:
- Android - 2.2+ (支持)
- iOS - 4.3+ (支持)
示例:
uni-app使用plus注意事项
FileReader
文件系统中的读取文件对象,用于获取文件的内容
说明:
FileReader对象是从设备文件系统读取文件FileReader对象是从设备文件系统读取文件的一种方式,文件以文本或者Base64编码的字符串形式读出来。 用户注册自己的事件监听器来接收loadstart、progress、load、loadend、error和abort事件。
构造:
常量:
属性:
方法:
事件:
FileReader
创建读取文件对象
说明:
创建读取文件对象
参数:
无
返回值:
FileReader :
EMPTY
值为0,开始读取文件状态
说明:
Number 类型
LOADING
值为1,正在读取文件状态
说明:
Number 类型
DONE
值为2,读文件操作完成状态
说明:
Number 类型
readyState
当前读取文件所处的状态
说明:
Number 类型 只读属性
可取上面定义的常量值,EMPTY(0)、LOADING(1)、DONE(2)。
result
已读取文件的内容
说明:
String 类型 只读属性
error
文件操作错误代码
说明:
Number 类型 只读属性
abort
终止文件读取操作
说明:
读取文件操作开始后,可通过此方法取消读取文件。 调用此方法后将触发文件读取对象的onabort事件。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
readAsDataURL
以URL编码格式读取文件数据内容
说明:
读取文件的数据内容,并将数据内容进行URL编码。
参数:
- file: ( File ) 必选 要读取的文件数据对象
- encoding : ( String ) 可选 读取文件数据内容的字符编码格式
目前仅支持UTF-8编码格式。
返回值:
void : 无
示例:
uni-app使用plus注意事项
readAsText
以文本格式读取文件数据内容
说明:
读取文件的数据内容。
参数:
- file: ( File ) 必选 要读取的文件数据对象
- encoding : ( String ) 可选 读取文件数据内容的字符编码格式
目前仅支持UTF-8编码格式。
返回值:
void : 无
示例:
uni-app使用plus注意事项
onloadstart
读取文件开始时的回调函数
说明:
FileEventCallback 类型
onload
读取文件成功完成的回调函数
说明:
FileEventCallback 类型
onabort
取消读取文件时的回调函数
说明:
FileEventCallback 类型
onerror
文件读取操作失败时调用的回调函数
说明:
FileEventCallback 类型
onloadend
文件读取操作完成时的回调函数
说明:
FileEventCallback 类型
不管成功或失败都会触发。
FileWriter
文件系统中的写文件对象,用于写入文件内容
说明:
FileWriter对象是向设备文件系统写入文件的一种方式,用户注册自己的事件监听器来接收writestart、progress、write、writeend、error和abort事件。 一个FileWriter对象是为单个文件的操作而创建,可以使用该对象多次对相应文件进行写入操作。 FileWriter维护该文件的指针位置及长度属性,这样就可以寻找和写入文件的任何地方。 默认情况下,FileWriter从文件的开头开始写入(将覆盖现有数据),seek方法可设置文件操作指定位置,如fw.seek(fw.length-1)写入操作就会从文件的末尾开始。
常量:
属性:
方法:
事件:
INIT
值为0,写文件初始化状态
说明:
Number 类型
WRITING
值为1,正在写入文件状态
说明:
Number 类型
DONE
值为2,写文件操作完成状态
说明:
Number 类型
readyState
当前写入文件所处的状态
说明:
Number 类型 只读属性
可取上面定义的常量值,INIT(0)、WRITING(1)、DONE(2)。
length
文件当前的长度,单位为字节
说明:
Number 类型 只读属性
position
文件当前操作的指针位置
说明:
Number 类型 只读属性
error
文件写入操作错误代码
说明:
Number 类型 只读属性
abort
终止文件写入操作
说明:
写入文件数据操作开始后,可通过此方法取消写入文件数据操作。 调用此方法后将触发文件写入对象的onabort事件。
参数:
返回值:
void : 无
示例:
uni-app使用plus注意事项
seek
定位文件操作位置
说明:
定位文件的操作位置,有效值为0到文件的总长度减1。 0表示文件的起始位置。
参数:
- position: ( Number ) 必选 要定位到的位置
返回值:
void : 无
示例:
uni-app使用plus注意事项
truncate
按照指定长度截断文件
说明:
从文件当前定位的位置开始,按照指定长度截断文件。
参数:
- length : ( Number ) 必选 截断后的文件长度
返回值:
void : 无
示例:
uni-app使用plus注意事项
write
向文件中写入数据
说明:
从文件当前定位的位置开始,写入数据到文件中。 如果文件中已经存在数据,新写入的数据将覆盖已有数据。
参数:
- data : ( String ) 必选 要写入的数据内容
返回值:
void : 无
示例:
uni-app使用plus注意事项
onwritestart
写入文件开始时的回调函数
说明:
FileEventCallback 类型
onwrite
写入文件成功完成的回调函数
说明:
FileEventCallback 类型
onabort
取消写入文件时的回调函数
说明:
FileEventCallback 类型
onerror
文件写入操作失败时调用的回调函数
说明:
FileEventCallback 类型
onwriteend
文件写入操作完成时的回调函数
说明:
FileEventCallback 类型
不管成功或失败都会触发。
FileSystem
文件系统对象,用于管理特定本地文件目录
说明:
文件系统对象表示一个应用可访问的根目录。name属性用于标识此根目录的名称,与LocalFileSystem中的文件系统类型一一对应。root属性为文件目录对象,用于实际操作文件系统,参考DirectoryEntry。
属性:
示例:
uni-app使用plus注意事项
name
文件系统的名称
说明:
String 类型 只读属性
值为文件系统类型常量值字符串,如“PRIVATE_WWW”、“PRIVATE_DOCUMENTS”。
root
文件系统的根目录
说明:
DirectoryEntry 类型 只读属性
Flags
JSON对象,获取文件操作的参数
属性:
Metadata
JSON对象,保存文件或目录的状态信息对象
说明:
可通过DirectoryEntry或FileEntry对象的getMetaData方法获取
属性:
- modificationTime: (Date 类型 )文件或目录的最后修改时间
- size: (Number 类型 )文件的大小
若获取的是目录对象的属性则值为0。
- directoryCount: (Number 类型 )包含的子目录数
若自身是文件则其值为0。
- fileCount: (Number 类型 )目录的文件数
若自身是文件则其值为0。
FileEvent
文件或目录操作事件对象
说明:
所有文件或目录操作事件回调函数中都创建该对象的实例。 该对象从DOMEvent继承而来,可通过该其target属性获取事件触发的文件或目录操作对象。
属性:
RelativeURL
相对路径URL
说明:
用于访问5+ API中定义的应用沙盒目录,以“_”开头。
常量:
- "_www": (String 类型 )应用私有资源目录
对应常量plus.io.PRIVATE_WWW,仅应用自身可读。 保存应用的所有html、css、js等资源文件,“_www”后面加资源相对路径,如“_www/res/icon.png”。
注意:应用资源目录是只读目录,只能读取此目录下的文件,不能修改或新建。
- "_doc": (String 类型 )应用私有文档目录
对应常量plus.io.PRIVATE_DOC,仅应用自身可读写。 用于保存应用运行期业务逻辑数据,“_doc”后面加资源相对路径,如“_doc/userdata.json”。
- "_documents": (String 类型 )程序公用文档目录
对应常量plus.io.PUBLIC_DOCUMENTS,多应用时都可共享读写。 用于保存程序中各应用间可共享文件的目录,“_document”后面加资源相对路径,如“_document/share.doc”。
- "_downloads": (String 类型 )程序公用下载目录
对应常量plus.io.PUBLIC_DOWNLOADS,多应用时都可共享读写。 用于保存程序中各应用间可共享的下载文件目录,“_download”后面加资源相对路径,,如“_download/mydoc.doc”。
LocalURL
本地绝对路径URL
说明:
可在html页面中直接访问本地文件系统资源,以“file://”开头,后面跟随系统的绝对路径。
平台支持:
- Android - ALL (支持) :
如Android平台公共目录文件系统绝对路径为“/storage/emulated/0/DCIM/a.jpg”,对应的本地绝对路径URL为“file:///storage/emulated/0/DCIM/a.jpg”。
注意:Android10及以上系统对公共目录文件的访问有更严格的限制,详情参考:Android平台适配分区存储机制注意事项
- iOS - ALL (支持) :
如iOS平台绝对路径为“/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png”, 对应的本地绝对路径URL为“file:///var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/Library/Pandora/apps/HBuilder/doc/a.png”。 其中“/var/mobile/Containers/Data/Application/757966CF-345C-4348-B07F-EEF83CF9A369/”为iOS应用沙盒目录,安装后由系统分配。
注意:系统限制应用只能访问iOS应用沙盒目录,不能访问系统其它目录,绝地路径可用于访问5+ API定义的应用沙盒目录外的资源。
RemoteURL
网络路径URL
说明:
可在html页面中以网络资源模式访问本地资源,以“http://”开头,后面跟随相对路径。 如“http://www.dcloud.io/icon.png”。
AudioInfo
JSON对象,音频文件信息对象
说明:
通过getAudioInfo方法的成功回调函数返回
属性:
- duration: (Number 类型 )音频长度
单位为秒(s)。
FileInfo
JSON对象,文件信息对象
说明:
通过getFileInfo方法的成功回调函数返回
属性:
ImageInfo
JSON对象,图片信息对象
说明:
通过getImageInfo方法的成功回调函数返回
属性:
VideoInfo
JSON对象,视频文件信息对象
说明:
通过getVideoInfo方法的成功回调函数返回
属性:
FileEventCallback
文件事件回调
说明:
文件或目录操作回调事件。 通常在FileReader和FileWriter对象的事件函数中触发。
参数:
返回值:
void : 无
FileSystemSuccessCallback
请求文件系统成功的回调函数
参数:
返回值:
void : 无
FileResolveSuccessCallback
通过URL参数获取目录或文件对象成功的回调函数
参数:
返回值:
void : 无
MetadataSuccessCallback
获取文件或目录状态信息成功的回调函数
参数:
返回值:
void : 无
EntrySuccessCallback
操作文件或目录对象成功的回调函数
参数:
返回值:
void : 无
EntrysSuccessCallback
操作文件或目录对象数组成功的回调函数
参数:
返回值:
void : 无
FileWriterSuccessCallback
写文件操作成功的回调函数
参数:
返回值:
void : 无
FileSuccessCallback
文件操作成功的回调函数
参数:
- file: ( File ) 必选 文件数据对象的引用
返回值:
void : 无
FileErrorCallback
文件操作失败的回调函数
参数:
- error: ( Exception ) 必选 文件操作失败的信息
返回值:
void : 无
IOSuccessCallback
成功回调函数
说明:
不同接口触发的成功回调参数event包含的属性存在差异,具体参考对应的接口描述说明。
参数:
返回值:
void : 无
IOFailCallback
失败回调函数
参数:
返回值:
void : 无
IOCompleteCallback
操作完成回调函数
说明:
调用成功或失败都会触发此回调。
参数:
返回值:
void : 无