From 4f7f8fb12c32ea87eabf37b4f422fc82392089f9 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Tue, 18 Jan 2022 18:13:53 +0800 Subject: [PATCH 1/4] update statfs api Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-statfs.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) 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 c6575cb730d..de83a64b5d3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -56,10 +56,10 @@ getFreeBytes(path:string, callback:AsyncCallback<number>): void - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback<void> | 是 | 异步获取空闲字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback<number> | 是 | 异步获取空闲字节数之后的回调 | - 示例： @@ -101,10 +101,10 @@ getTotalBytes(path:string, callback:AsyncCallback<number>): void - 参数： - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------- | - | path | string | 是 | 需要查询的文件系统的文件路径 | - | callback | AsyncCallback<void> | 是 | 异步获取总字节数之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | ---------------------------- | + | path | string | 是 | 需要查询的文件系统的文件路径 | + | callback | AsyncCallback<number> | 是 | 异步获取总字节数之后的回调 | - 示例： -- Gitee From 6d84f8b8a2d25aa03a0594b6c82027b70e74be36 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 20 Jan 2022 10:55:33 +0800 Subject: [PATCH 2/4] add environment api Signed-off-by: zhangxingxia --- .../reference/apis/Readme-CN.md | 1 + .../reference/apis/js-apis-environment.md | 108 ++++++++++++++++++ 2 files changed, 109 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-environment.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 1e194b86edf..ff2812c2fd3 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -26,6 +26,7 @@ - 文件管理 - [文件管理](js-apis-fileio.md) - [Statfs管理](js-apis-statfs.md) + - [目录环境](js-apis-environment.md) - 账号管理 - [分布式帐号管理](js-apis-distributed-account.md) - [应用帐号管理](js-apis-appAccount.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-environment.md b/zh-cn/application-dev/reference/apis/js-apis-environment.md new file mode 100644 index 00000000000..b2d7680e944 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -0,0 +1,108 @@ +# 目录环境能力 + + + +## 支持设备 + +| 手机 | 平板 | 智慧屏 | 智能穿戴 | +| ---- | ---- | ------ | -------- | +| 支持 | 支持 | 支持 | 支持 | + + + +## 导入模块 + +``` +import environment from '@ohos.environment'; +``` + + + +## 权限列表 + +无 + +## environment.getStorageDataDir + +getStorageDataDir():Promise<string> + +异步方法获取内存存储根目录，以Promise形式返回结果。 + +- 返回值： + + | 类型 | 说明 | + | --------------------- | ---------------- | + | Promise<string> | 返回存存储根目录 | + +- 示例： + + ``` + environment.getStorageDataDir().then(function(path){ + // do something + }).catch(function(error){ + + }); + ``` + +## environment.getStorageDataDir + +getStorageDataDir(callback:AsyncCallback<string>):void + +异步方法获取内存存储根目录，以callback形式返回结果。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | -------------------------------- | + | callback | AsyncCallback<string> | 是 | 异步获取内存存储根目录之后的回调 | + +- 示例： + + ``` + environment.getStorageDataDir(function(error, path){ + // do something + }); + ``` + +## getUserDataDir + +getUserDataDir():Promise<string> + +异步方法获取公共文件根目录，以Promise形式返回结果。 + +- 返回值： + + | 类型 | 说明 | + | --------------------- | ------------------ | + | Promise<string> | 返回公共文件根目录 | + +- 示例： + + ``` + environment.getUserDataDir().then(function(path){ + // do something + }).catch(function(error){ + + }); + ``` + +## getUserDataDir + +getUserDataDir(callback:AsyncCallback<string>): void + +异步方法获取公共文件根目录，以callback形式返回结果。 + +- 参数： + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------- | ---- | -------------------------------- | + | callback | AsyncCallback<string> | 是 | 异步获取公共文件根目录之后的回调 | + +- 示例： + + ``` + environment.getUserDataDir(function(error, path){ + // do something + }); + ``` + -- Gitee From 08301c5398e9701cadb037116f50efe948357e30 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 20 Jan 2022 14:09:33 +0800 Subject: [PATCH 3/4] update readme Signed-off-by: zhangxingxia --- zh-cn/application-dev/reference/apis/Readme-CN.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index ff2812c2fd3..6a9479db0b9 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -25,7 +25,7 @@ - [设置数据项名称](js-apis-settings.md) - 文件管理 - [文件管理](js-apis-fileio.md) - - [Statfs管理](js-apis-statfs.md) + - [Statfs](js-apis-statfs.md) - [目录环境](js-apis-environment.md) - 账号管理 - [分布式帐号管理](js-apis-distributed-account.md) -- Gitee From da756b7949b7296a7de328706e18163741b8df23 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Fri, 21 Jan 2022 16:09:16 +0800 Subject: [PATCH 4/4] update environment api Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-environment.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 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 b2d7680e944..aeab8cf8d8b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-environment.md +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -2,14 +2,6 @@ -## 支持设备 - -| 手机 | 平板 | 智慧屏 | 智能穿戴 | -| ---- | ---- | ------ | -------- | -| 支持 | 支持 | 支持 | 支持 | - - - ## 导入模块 ``` @@ -26,7 +18,7 @@ import environment from '@ohos.environment'; getStorageDataDir():Promise<string> -异步方法获取内存存储根目录，以Promise形式返回结果。 +异步方法获取内存存储根目录，以promise形式返回结果。 - 返回值： @@ -68,7 +60,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void getUserDataDir():Promise<string> -异步方法获取公共文件根目录，以Promise形式返回结果。 +异步方法获取公共文件根目录，以promise形式返回结果。 - 返回值： -- Gitee