From 2cf8bc3f06e9607b23026ef447e16ba3ce055a57 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Fri, 11 Feb 2022 14:20:11 +0800 Subject: [PATCH] update apis Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-environment.md | 19 +++++----- .../reference/apis/js-apis-filemanager.md | 36 +++++++++++-------- .../reference/apis/js-apis-statfs.md | 19 +++++----- 3 files changed, 40 insertions(+), 34 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-environment.md b/zh-cn/application-dev/reference/apis/js-apis-environment.md index 2d38edd1d10..c4077db9a74 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-environment.md +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -1,18 +1,17 @@ # 目录环境能力 - +> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import environment from '@ohos.environment'; ``` +## 系统能力 - -## 权限列表 - -无 +SystemCapability.FileManagement.File.Environment ## environment.getStorageDataDir @@ -28,7 +27,7 @@ getStorageDataDir():Promise<string> - 示例： - ``` + ```js environment.getStorageDataDir().then(function(path){ // do something }).catch(function(error){ @@ -50,7 +49,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void - 示例： - ``` + ```js environment.getStorageDataDir(function(error, path){ // do something }); @@ -70,7 +69,7 @@ getUserDataDir():Promise<string> - 示例： - ``` + ```js environment.getUserDataDir().then(function(path){ // do something }).catch(function(error){ @@ -92,7 +91,7 @@ getUserDataDir(callback:AsyncCallback<string>): void - 示例： - ``` + ```js environment.getUserDataDir(function(error, path){ // do something }); diff --git a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md index 897f1063ead..173e64ef45a 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-filemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-filemanager.md @@ -1,16 +1,18 @@ # 公共文件访问与管理 - +>![](../../public_sys-resources/icon-note.gif) **说明：** +>本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import filemanager from 'ohos.filemanager' ``` -## 权限 +## 系统能力 -应用需要拥有SystemCapability.FileManagement.FileManagerService权限 +SystemCapability.FileManagement.FileManagerService ## filemanager.getRoot + getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]> 以异步方法获取第一层相册，目录信息。使用promise形式返回结果。 @@ -18,13 +20,13 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]> - 参数 | 参数名 | 类型 | 必填 | 说明 | | --- | --- | --- | -- | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - 返回值 | 类型 | 说明 | | --- | -- | - | Promise<FileInfo[]> | 第一层目录相册信息 | + | Promise<[FileInfo](#fileinfo)[]> | 第一层目录相册信息 | - 示例 @@ -52,8 +54,8 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback<FileInfo[]>) | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------------------- | ---- | ----------------------------- | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 示例 @@ -78,10 +80,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num | --- | --- | --- | -- | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | path | string | 是 | 待查询目录uri | - | dev | DevInfo | 是 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | | offset | number | 否 | 待查询文件偏移 | | count | number | 否 | 待查询文件个数 | - + - 返回值 | 类型 | 说明 | @@ -123,10 +125,10 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num | -------- | ------------------------- | ---- | ------------------------------------------------------------ | | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" | | path | string | 是 | 待查询目录uri | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | | offset | number | 否 | 待查询文件偏移 | | count | number | 否 | 待查询文件个数 | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 异常 | 错误名称 | 错误类型 | 错误码 | 说明 | @@ -158,7 +160,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI | --- | --- | --- | -- | | filename | string | 是 | 待创建的文件名 | | path | string | 是 | 待保存目的相册uri | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | - 返回值 @@ -199,8 +201,8 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac | -------- | ------------------------- | ---- | ----------------------------- | | filename | string | 是 | 待创建的文件名 | | path | string | 是 | 待保存目的相册uri | - | dev | DevInfo | 否 | 设备名, 当前仅支持设备'local' | - | callback | AsyncCallback<FileInfo[]> | 是 | 异步获取文件的信息之后的回调 | + | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' | + | callback | AsyncCallback<[FileInfo](#fileinfo)[]> | 是 | 异步获取文件的信息之后的回调 | - 异常 @@ -225,6 +227,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ## FileInfo 文件信息类型，通过getRoot, listFile等接口返回的类型。 +### 属性 + | 参数名 | 类型 | 可读 | 可写 | 说明 | | --- | -- | -- | -- | -- | | name | string | 是 | 否 | 文件名称 | @@ -237,6 +241,8 @@ filemanager.createFile(media_path, name, (err, uri) => { ## DevInfo 设备类型，配置接口访问的设备类型。 +### 属性 + | 参数名 | 类型 | 可读 | 可写 | 说明 | | --- | -- | -- | -- | -- | | name | string | 是 | 是 | 设备名称 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index de83a64b5d3..12921a2a414 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -1,10 +1,11 @@ # statfs - +> ![icon-note.gif](D:/docs/zh-cn/application-dev/reference/apis/public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -``` +```js import statfs from '@ohos.statfs' ``` @@ -16,13 +17,13 @@ import statfs from '@ohos.statfs' 通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： -``` +```js let path = dir + "xxx.txt" ``` -## 权限列表 +## 系统能力 -无 +SystemCapability.FileManagement.File.FileIO ## statfs.getFreeBytes @@ -44,7 +45,7 @@ getFreeBytes(path:string):Promise<number> - 示例： - ``` + ```js let num = await statfs.getFreeBytes(path); ``` @@ -63,7 +64,7 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void - 示例： - ``` + ```js statfs.getFreeBytes(path, function(err, number){ //do something }); @@ -89,7 +90,7 @@ getTotalBytes.(path:string):Promise<number> - 示例： - ``` + ```js let num = await statfs.getTotalBytes(path); ``` @@ -108,7 +109,7 @@ getTotalBytes(path:string, callback:AsyncCallback<number>): void - 示例： - ``` + ```js statfs.getTotalBytes(path, function(err, number){ //do something }); -- Gitee