js-apis-environment.md 2.6 KB
Newer Older
Z
zhangxingxia 已提交
1 2
# 目录环境能力

Z
zhangxingxia 已提交
3
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
Z
zhangxingxia 已提交
4
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
Z
zhangxingxia 已提交
5 6 7

## 导入模块

Z
zhangxingxia 已提交
8
```js
Z
zhangxingxia 已提交
9 10 11
import environment from '@ohos.environment';
```

Z
zhangxingxia 已提交
12
## 系统能力
Z
zhangxingxia 已提交
13

Z
zhangxingxia 已提交
14
SystemCapability.FileManagement.File.Environment
Z
zhangxingxia 已提交
15 16 17 18 19

## environment.getStorageDataDir

getStorageDataDir():Promise<string>

Z
zhangxingxia 已提交
20
异步方法获取内存存储根目录,以promise形式返回结果。
Z
zhangxingxia 已提交
21 22 23 24 25 26 27 28 29

- 返回值:

  | 类型                  | 说明             |
  | --------------------- | ---------------- |
  | Promise<string> | 返回存存储根目录 |

- 示例:

Z
zhangxingxia 已提交
30
  ```js
Z
zhangxingxia 已提交
31
  environment.getStorageDataDir().then(function(path){
Z
zhangxingxia 已提交
32
      console.info("getStorageDataDir successfully:"+ path);
Z
zhangxingxia 已提交
33
  }).catch(function(error){
Z
zhangxingxia 已提交
34
      console.info("getStorageDataDir failed with error:"+ error);
Z
zhangxingxia 已提交
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
  });
  ```

## environment.getStorageDataDir

getStorageDataDir(callback:AsyncCallback<string>):void

异步方法获取内存存储根目录,以callback形式返回结果。

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                             |
  | -------- | --------------------------- | ---- | -------------------------------- |
  | callback | AsyncCallback<string> | 是   | 异步获取内存存储根目录之后的回调 |

- 示例:

Z
zhangxingxia 已提交
52
  ```js
Z
zhangxingxia 已提交
53 54 55 56 57
  environment.getStorageDataDir(function(error, path){
      // do something
  });
  ```

Z
zengyawen 已提交
58
## environment.getUserDataDir
Z
zhangxingxia 已提交
59 60 61

getUserDataDir():Promise<string>

Z
zhangxingxia 已提交
62
异步方法获取公共文件根目录,以promise形式返回结果。
Z
zhangxingxia 已提交
63 64 65 66 67 68 69 70 71

- 返回值:

  | 类型                  | 说明               |
  | --------------------- | ------------------ |
  | Promise<string> | 返回公共文件根目录 |

- 示例:

Z
zhangxingxia 已提交
72
  ```js
Z
zhangxingxia 已提交
73
  environment.getUserDataDir().then(function(path){
Z
zhangxingxia 已提交
74
      console.info("getUserDataDir successfully:"+ path);
Z
zhangxingxia 已提交
75
  }).catch(function(error){
Z
zhangxingxia 已提交
76
      console.info("getUserDataDir failed with error:"+ error);
Z
zhangxingxia 已提交
77 78 79
  });
  ```

Z
zengyawen 已提交
80
## environment.getUserDataDir
Z
zhangxingxia 已提交
81 82 83 84 85 86 87 88 89 90 91 92 93

getUserDataDir(callback:AsyncCallback<string>): void

异步方法获取公共文件根目录,以callback形式返回结果。

- 参数:

  | 参数名   | 类型                        | 必填 | 说明                             |
  | -------- | --------------------------- | ---- | -------------------------------- |
  | callback | AsyncCallback<string> | 是   | 异步获取公共文件根目录之后的回调 |
  
- 示例:

Z
zhangxingxia 已提交
94
  ```js
Z
zhangxingxia 已提交
95 96 97 98 99
  environment.getUserDataDir(function(error, path){
      // do something
  });
  ```