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

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

该模块提供环境目录能力,获取内存存储根目录、公共文件根目录的JS接口。
Z
zhangxingxia 已提交
9 10 11

## 导入模块

Z
zhangxingxia 已提交
12
```js
Z
zhangxingxia 已提交
13 14 15 16 17 18 19
import environment from '@ohos.environment';
```

## environment.getStorageDataDir

getStorageDataDir():Promise<string>

Z
zhangxingxia 已提交
20
异步方法获取内存存储根目录,以promise形式返回结果。
Z
zhangxingxia 已提交
21

22
**系统能力**:SystemCapability.FileManagement.File.Environment
X
xuezhongzhu 已提交
23

Z
zhangxingxia 已提交
24 25 26 27 28 29 30 31
- 返回值:

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

- 示例:

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

## environment.getStorageDataDir

getStorageDataDir(callback:AsyncCallback<string>):void

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

46
**系统能力**:SystemCapability.FileManagement.File.Environment
X
xuezhongzhu 已提交
47

Z
zhangxingxia 已提交
48 49 50 51 52 53 54 55
- 参数:

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

- 示例:

Z
zhangxingxia 已提交
56
  ```js
Z
zhangxingxia 已提交
57 58 59 60 61
  environment.getStorageDataDir(function(error, path){
      // do something
  });
  ```

Z
zengyawen 已提交
62
## environment.getUserDataDir
Z
zhangxingxia 已提交
63 64 65

getUserDataDir():Promise<string>

Z
zhangxingxia 已提交
66
异步方法获取公共文件根目录,以promise形式返回结果。
Z
zhangxingxia 已提交
67

68
**系统能力**:SystemCapability.FileManagement.File.Environment
X
xuezhongzhu 已提交
69

Z
zhangxingxia 已提交
70 71 72 73 74 75 76 77
- 返回值:

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

- 示例:

Z
zhangxingxia 已提交
78
  ```js
Z
zhangxingxia 已提交
79
  environment.getUserDataDir().then(function(path){
Z
zhangxingxia 已提交
80
      console.info("getUserDataDir successfully:"+ path);
Z
zhangxingxia 已提交
81
  }).catch(function(error){
Z
zhangxingxia 已提交
82
      console.info("getUserDataDir failed with error:"+ error);
Z
zhangxingxia 已提交
83 84 85
  });
  ```

Z
zengyawen 已提交
86
## environment.getUserDataDir
Z
zhangxingxia 已提交
87 88 89 90 91

getUserDataDir(callback:AsyncCallback<string>): void

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

92
**系统能力**:SystemCapability.FileManagement.File.Environment
X
xuezhongzhu 已提交
93

Z
zhangxingxia 已提交
94 95 96 97 98 99 100 101
- 参数:

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

Z
zhangxingxia 已提交
102
  ```js
Z
zhangxingxia 已提交
103 104 105 106 107
  environment.getUserDataDir(function(error, path){
      // do something
  });
  ```