diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 2a2f11b15669dc859e83283290be8b17e0f58b68..2d214b980f18be1a85ab2afbb678fa02a8a26e36 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -33,7 +33,6 @@ - [文件管理](js-apis-fileio.md) - [Statfs](js-apis-statfs.md) - [目录环境](js-apis-environment.md) - - [公共文件访问与管理](js-apis-filemanager.md) - [应用空间统计](js-apis-storage-statistics.md) - [卷管理](js-apis-volumemanager.md) - 账号管理 diff --git a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md deleted file mode 100644 index 5c520aef02ef740eb995f5deaaf250815dd969c6..0000000000000000000000000000000000000000 --- a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md +++ /dev/null @@ -1,246 +0,0 @@ -# 公共文件访问与管理 ->![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** ->本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -## 导入模块 - -```js -import filemanager from 'ohos.filemanager'; -``` - -## 系统能力 - -SystemCapability.FileManagement.FileManagerService - -## filemanager.getRoot - -getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]> - -以异步方法获取第一层相册，目录信息。使用promise形式返回结果。 - -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | --- | --- | --- | -- | - | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - -- 返回值 - - | 类型 | 说明 | - | --- | -- | - | Promise<[FileInfo](#fileinfo)[]> | 第一层目录相册信息 | - -- 示例 - -```js -filemanager.getRoot().then((fileInfo) => { - if(Array.isArray(fileInfo)) { - for (var i = 0; i < fileInfo.length; i++) { - console.log(JSON.Stringify(fileInfo)) - } - } -}).catch((err) => { - console.log(err) -}); -``` - -## filemanager.getRoot - -getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>) : void - -以异步方法获取第一层相册，目录信息。使用callback形式返回结果。 - -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ----------------------------- | - | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - -- 示例 - -```js -filemanager.getRoot((err, fileInfo) => { - if(Array.isArray(fileInfo)) { - for (var i = 0; i < fileInfo.length; i++) { - console.log(JSON.Stringify(fileInfo)) - } - } -}) -``` - -## filemanager.listFile - -listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}) : Promise<FileInfo[]> - -以异步方法获取获取第二层相册，文件信息。使用promise形式返回结果。 - -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | --- | --- | --- | -- | - | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | - | path | string | 是 | 待查询目录uri | - | dev | [DevInfo](#devinfo) | 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - | offset | number | 否 | 待查询文件偏移 | - | count | number | 否 | 待查询文件个数 | - -- 返回值 - - | 类型 | 说明 | - | --- | -- | - | Promise<FileInfo[]> | 文件信息 | - -- 异常 - | 错误名称 | 错误类型 | 错误码 |说明 | - | --- | -- | --- | -- | - | 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 | - | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 | - | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 | - -```js -// 获取目录下所有文件 -// 通过listFile、getRoot获取的文件uri -let media_path = file.uri -filemanager.listFile(media_path, "file") -.then((fileInfo) => { - if(Array.isArray(fileInfo)) { - for (var i = 0; i < fileInfo.length; i++) { - console.log(JSON.Stringify(fileInfo)) - } - } -}) -.catch((err) => { - console.log(err) -}) -``` -## filemanager.listFile - -listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback<FileInfo[]>) : void - -以异步方法获取获取第二层相册，文件信息。使用callback形式返回结果。 - -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------------------------------------------------------ | - | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | - | path | string | 是 | 待查询目录uri | - | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - | offset | number | 否 | 待查询文件偏移 | - | count | number | 否 | 待查询文件个数 | - | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | -- 异常 - - | 错误名称 | 错误类型 | 错误码 | 说明 | - | ------------------------- | ------------------------- | ------ | ------------------------- | - | 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 | - | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 | - | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 | - -```js -// 通过listFile、getRoot获取的文件uri -let media_path = file.uri -filemanager.listFile(media_path, "file", (err, fileInfo) => { - if(Array.isArray(fileInfo)) { - for (var i = 0; i < fileInfo.length; i++) { - console.log(JSON.Stringify(fileInfo)) - } - } -}) -``` - -## filemanager.createFile - -filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo}) : promise<string> - -以异步方法创建文件到指定路径，返回文件uri。使用promise形式返回结果。 - -- 参数 - | 参数名 | 类型 | 必填 | 说明 | - | --- | --- | --- | -- | - | filename | string | 是 | 待创建的文件名 | - | path | string | 是 | 待保存目的相册uri | - | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - -- 返回值 - - | 类型 | 说明 | - | --- | -- | - | string | 文件uri | - -- 异常 - | 错误名称 | 错误类型 | 错误码 |说明 | - | --- | -- | --- | -- | - | 创建文件不允许 | Operation not permitted | 1 | 已有重名文件 | - | 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 | - | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 | - | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 | - -```js -// 创建文件，返回文件uri -let media_path = file.uri // 通过listFile、getRoot获取的文件uri -let name = "xxx.jpg" // 待保存文件的后缀 -filemanager.createFile(media_path, name) -.then((uri) => { -// 返回uri给应用 -}) -.catch((err) => { - console.log(err) -}) -``` - -## filemanager.createFile - -createFile(path : string, filename: string, options? : {dev? : DevInfo}, callback : AsyncCallback<string>) : void - -以异步方法创建文件到指定路径，返回文件uri。使用callback形式返回结果。 - -- 参数 - - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ----------------------------- | - | filename | string | 是 | 待创建的文件名 | - | path | string | 是 | 待保存目的相册uri | - | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - -- 异常 - - | 错误名称 | 错误类型 | 错误码 | 说明 | - | ------------------------- | ------------------------- | ------ | ------------------------- | - | 创建文件不允许 | Operation not permitted | 1 | 已有重名文件 | - | 对应的目录、相册不存在 | No such file or directory | 2 | uri对应的目录、相册不存在 | - | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 | - | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 | - -```js -// 创建文件，返回文件uri -// 通过listFile、getRoot获取的文件uri -let media_path = file.uri -// 待保存文件的后缀 -let name = "xxx.jpg" -filemanager.createFile(media_path, name, (err, uri) => { -// 返回uri给应用 -}) -``` - -## FileInfo -文件信息类型，通过getRoot, listFile等接口返回的类型。 - -### 属性 - -| 参数名 | 类型 | 可读 | 可写 | 说明 | -| --- | -- | -- | -- | -- | -| name | string | 是 | 否 | 文件名称 | -| path | string | 是 | 否 | 文件Uri | -| type | string | 是 | 否 | 文件类型 | -| size | number | 是 | 否 | 文件大小 | -| addedTime | number | 是 | 否 | 媒体插入时间 | -| modifiedTime | number | 是 | 否 | 媒体修改时间 | - -## DevInfo -设备类型，配置接口访问的设备类型。 - -### 属性 - - | 参数名 | 类型 | 可读 | 可写 | 说明 | - | --- | -- | -- | -- | -- | - | name | string | 是 | 是 | 设备名称 | \ No newline at end of file