js-apis-environment.md 2.8 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 12 13 14 15
import environment from '@ohos.environment';
```

## environment.getStorageDataDir

getStorageDataDir():Promise<string>

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

X
xuezhongzhu 已提交
18 19 20 21
- 系统能力:

  SystemCapability.FileManagement.File.Environment

Z
zhangxingxia 已提交
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
  });
  ```

## environment.getStorageDataDir

getStorageDataDir(callback:AsyncCallback<string>):void

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

X
xuezhongzhu 已提交
44 45 46 47
- 系统能力:

  SystemCapability.FileManagement.File.Environment

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

X
xuezhongzhu 已提交
68 69 70 71
- 系统能力:

  SystemCapability.FileManagement.File.Environment

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

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

- 示例:

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

Z
zengyawen 已提交
88
## environment.getUserDataDir
Z
zhangxingxia 已提交
89 90 91 92 93

getUserDataDir(callback:AsyncCallback<string>): void

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

X
xuezhongzhu 已提交
94 95 96 97
- 系统能力:

  SystemCapability.FileManagement.File.Environment

Z
zhangxingxia 已提交
98 99 100 101 102 103 104 105
- 参数:

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

Z
zhangxingxia 已提交
106
  ```js
Z
zhangxingxia 已提交
107 108 109 110 111
  environment.getUserDataDir(function(error, path){
      // do something
  });
  ```