From 6d84f8b8a2d25aa03a0594b6c82027b70e74be36 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 20 Jan 2022 10:55:33 +0800 Subject: [PATCH] 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 1e194b86ed..ff2812c2fd 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 0000000000..b2d7680e94 --- /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 + }); + ``` + -- GitLab