js-apis-volumemanager.md 4.9 KB
Newer Older
1 2 3
# 卷管理

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

## 导入模块

```js
Z
zhangxingxia 已提交
11
import volumemanager from "@ohos.volumeManager";
12 13
```

Z
zhangxingxia 已提交
14
## volumemanager.getAllVolumes
15

16
getAllVolumes(): Promise<Array<Volume>>
17 18 19

异步获取当前所有可获得的卷信息,以promise方式返回。

20 21
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

22 23
- 返回值

Z
zhangxingxia 已提交
24 25 26
  | 类型                               | 说明                       |
  | ---------------------------------- | -------------------------- |
  | Promise<[Volume](#volume)[]> | 返回当前所有可获得的卷信息 |
27 28 29 30 31 32 33 34 35

- 示例

  ```js
  volumemanager.getAllVolumes().then(function(volumes){
      // do something
  });
  ```

36
## volumemanager.getAllVolumes<sup>9+</sup>
37

38
getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
39 40 41

异步获取当前所有可获得的卷信息,以callback方式返回。

42 43
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

44 45
- 参数

Z
zhangxingxia 已提交
46 47 48
  | 参数名   | 类型                                              | 必填 | 说明                                 |
  | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
  | callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是   | 获取当前所有可获得的卷信息之后的回调 |
49 50 51 52 53 54 55 56 57 58 59
  
- 示例

  ```js
  let uuid = "";
  volumemanager.getAllVolumes(uuid, function(error, volumes){
      // do something
  });
  ```


Z
zhangxingxia 已提交
60
## volumemanager.mount
61

Z
zhangxingxia 已提交
62
mount(volumeId: string): Promise&lt;boolean&gt;
63 64 65

异步挂载指定卷,以promise方式返回。

66 67
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

68 69 70 71 72 73 74 75
- 参数

  | 参数名   | 类型   | 必填 | 说明 |
  | -------- | ------ | ---- | ---- |
  | volumeId | string | 是   | 卷id |

- 返回值

Z
zhangxingxia 已提交
76 77 78
  | 类型                   | 说明       |
  | ---------------------- | ---------- |
  | Promise&lt;boolean&gt; | 挂载指定卷 |
79 80 81 82 83 84 85 86 87 88

- 示例

  ```js
  let volumeId = "";
  volumemanager.mount(volumeId).then(function(flag){
      // do something
  });
  ```

Z
zhangxingxia 已提交
89
## volumemanager.mount
90

Z
zhangxingxia 已提交
91
mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
92 93 94

异步获取指定卷的可用空间大小,以callback方式返回。

95 96
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

97 98
- 参数

Z
zhangxingxia 已提交
99 100 101 102
  | 参数名   | 类型                                  | 必填 | 说明                 |
  | -------- | ------------------------------------- | ---- | -------------------- |
  | volumeId | string                                | 是   | 卷id                 |
  | callback | callback:AsyncCallback&lt;boolean&gt; | 是   | 挂载指定卷之后的回调 |
103 104 105 106 107 108 109 110 111 112

- 示例

  ```js
  let volumeId = "";
  volumemanager.mount(volumeId, function(error, flag){
      // do something
  });
  ```

Z
zhangxingxia 已提交
113
## volumemanager.unmount
114

Z
zhangxingxia 已提交
115
unmount(volumeId: string): Promise&lt;boolean&gt;
116 117 118

异步卸载指定卷,以promise方式返回。

119 120
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

121 122 123 124 125 126 127 128
- 参数

  | 参数名   | 类型   | 必填 | 说明 |
  | -------- | ------ | ---- | ---- |
  | volumeId | string | 是   | 卷id |

- 返回值

Z
zhangxingxia 已提交
129 130 131
  | 类型                   | 说明       |
  | ---------------------- | ---------- |
  | Promise&lt;boolean&gt; | 卸载指定卷 |
132 133 134 135 136 137 138 139 140 141

- 示例

  ```js
  let volumeId = "";
  volumemanager.unmount(volumeId).then(function(flag){
      // do something
  });
  ```

Z
zhangxingxia 已提交
142
## volumemanager.unmount
143

Z
zhangxingxia 已提交
144
unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
145 146 147

异步卸载指定卷,以callback方式返回。

148 149
**系统能力**:SystemCapability.FileManagement.StorageService.Volume

150 151
- 参数

Z
zhangxingxia 已提交
152 153 154 155
  | 参数名   | 类型                                  | 必填 | 说明                 |
  | -------- | ------------------------------------- | ---- | -------------------- |
  | volumeId | string                                | 是   | 卷id                 |
  | callback | callback:AsyncCallback&lt;boolean&gt; | 是   | 卸载指定卷之后的回调 |
156 157 158 159 160 161 162 163 164 165

- 示例

  ```js
  let volumeId = "";
  volumemanager.unmount(volumeId, function(error, flag){
      // do something
  });
  ```

Z
zhangxingxia 已提交
166
## Volume
167

168 169
**系统能力**:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。

170 171 172 173
### 属性

| 名称        | 类型    | 说明                 |
| ----------- | ------- | -------------------- |
174 175 176
| id<sup>9+</sup>          | number  | 卷id                 |
| uuid<sup>9+</sup>        | string  | 卷uuid               |
| description<sup>9+</sup> | string  | 卷相关描述           |
Z
zengyawen 已提交
177
| removable<sup>9+</sup> | boolean | 是否为可移动存储设备 |
178 179
| state<sup>9+</sup>       | int     | 当前卷状态           |
| path<sup>9+</sup>        | string  | 卷的挂载地址         |