Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
提交 24db6cfa 编写于 作者: K kongzheng6@huawei.com
浏览文件
操作

update volumemanager docs 

Signed-off-by: Nkongzheng6@huawei.com <kongzheng6@huawei.com>
上级 9cae8443
隐藏空白更改
内联 并排
Showing with 44 addition and 47 deletion
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md
浏览文件 @ 24db6cfa
...@@ -198,7 +198,7 @@ getVolumeByUuid(uuid: string): Promise<Volume>; ...@@ -198,7 +198,7 @@ getVolumeByUuid(uuid: string): Promise<Volume>;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷信息 | | Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷信息 |
- 示例 - 示例
...@@ -222,7 +222,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void; ...@@ -222,7 +222,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------------------ | ---- | -------------------- |
| uuid | string | 是 | 卷uuid | | uuid | string | 是 | 卷uuid |
| callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取卷信息之后的回调 | | callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
- 示例 - 示例
...@@ -235,7 +235,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void; ...@@ -235,7 +235,7 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void;
## volumemanager.getVolumeById ## volumemanager.getVolumeById
getVolumeById(volumeId: string): Promise<Volume>; getVolumeById(id: string): Promise<Volume>;
异步通过卷id获得卷信息，以promise方式返回。 异步通过卷id获得卷信息，以promise方式返回。
...@@ -247,24 +247,24 @@ getVolumeById(volumeId: string): Promise<Volume>; ...@@ -247,24 +247,24 @@ getVolumeById(volumeId: string): Promise<Volume>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ---- | | -------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id | | id | string | 是 | 卷id |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------------------- | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷信息 | | Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷信息 |
- 示例 - 示例
```js ```js
let volumeId = ""; let id = "";
let volume = await volumemanager.getVolumeById(volumeId); let volume = await volumemanager.getVolumeById(id);
``` ```
## volumemanager.getVolumeById ## volumemanager.getVolumeById
getVolumeById(volumeId: string, callback: AsyncCallback<Volume>): void; getVolumeById(id: string, callback: AsyncCallback<Volume>): void;
异步通过卷id获得卷信息，以callback方式返回。 异步通过卷id获得卷信息，以callback方式返回。
...@@ -276,21 +276,21 @@ getVolumeById(volumeId: string, callback: AsyncCallback<Volume>): void; ...@@ -276,21 +276,21 @@ getVolumeById(volumeId: string, callback: AsyncCallback<Volume>): void;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------ | ---- | -------------------- | | -------- | ------------------------------------------------ | ---- | -------------------- |
| volumeId | string | 是 | volumeId | | id | string | 是 | 卷id |
| callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取卷信息之后的回调 | | callback | callback:AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷信息之后的回调 |
- 示例 - 示例
```js ```js
let volumeId = ""; let id = "";
volumemanager.getVolumeById(volumeId, (error, volume) => { volumemanager.getVolumeById(id, (error, volume) => {
// do something // do something
}); });
``` ```
## volumemanager.setVolumeDescription ## volumemanager.setVolumeDescription
setVolumeDescription(uuid: string, description: string): Promise<boolean>; setVolumeDescription(uuid: string, description: string): Promise<void>;
异步通过uuid设置卷描述，以promise方式返回。 异步通过uuid设置卷描述，以promise方式返回。
...@@ -309,7 +309,7 @@ setVolumeDescription(uuid: string, description: string): Promise<boolean>; ...@@ -309,7 +309,7 @@ setVolumeDescription(uuid: string, description: string): Promise<boolean>;
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | -------------------------- | | ---------------------- | -------------------------- |
| Promise&lt;boolean&gt; | 设置卷信息 | | Promise&lt;void&gt; | 设置卷信息 |
- 示例 - 示例
...@@ -321,7 +321,7 @@ setVolumeDescription(uuid: string, description: string): Promise<boolean>; ...@@ -321,7 +321,7 @@ setVolumeDescription(uuid: string, description: string): Promise<boolean>;
## volumemanager.setVolumeDescription ## volumemanager.setVolumeDescription
function setVolumeDescription(uuid: string, description: string, callback: AsyncCallback<boolean>): void; function setVolumeDescription(uuid: string, description: string, callback: AsyncCallback<void>): void;
异步通过uuid设置卷描述，以callback方式返回。 异步通过uuid设置卷描述，以callback方式返回。
...@@ -335,7 +335,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async ...@@ -335,7 +335,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async
| ---------- | --------------------------------------- | ---- | ---------------- | | ---------- | --------------------------------------- | ---- | ---------------- |
| uuid | string | 是 | 卷uuid | | uuid | string | 是 | 卷uuid |
| description | string | 是 | 卷描述 | | description | string | 是 | 卷描述 |
| callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 设置卷描述之后的回调 | | callback | callback:AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 |
- 示例 - 示例
...@@ -349,7 +349,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async ...@@ -349,7 +349,7 @@ function setVolumeDescription(uuid: string, description: string, callback: Async
## volumemanager.format ## volumemanager.format
format(volumeId: string, fsType: string): Promise<boolean>; format(volumeId: string, fsType: string): Promise<void>;
异步对指定卷进行格式化，以promise方式返回。 异步对指定卷进行格式化，以promise方式返回。
...@@ -361,26 +361,24 @@ format(volumeId: string, fsType: string): Promise<boolean>; ...@@ -361,26 +361,24 @@ format(volumeId: string, fsType: string): Promise<boolean>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- | | ----------- | ------ | ---- | ---- |
| volumeId | string | 是 | 卷id | | volId | string | 是 | 卷id |
| fsType | string | 是 | 文件系统类型 |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------------------- | | --------------------- | ----------------------- |
| Promise&lt;boolean&gt; | 对指定卷进行格式化 | | Promise&lt;void&gt; | 对指定卷进行格式化 |
- 示例 - 示例
```js ```js
let volumeId = ""; let volId = "";
let fsType = ""; let bool = await volumemanager.format(volId);
let bool = await volumemanager.format(volumeId, fsType);
``` ```
## volumemanager.format ## volumemanager.format
format(volumeId: string, fsType: string, callback: AsyncCallback<boolean>): void; format(volumeId: string, fsType: string, callback: AsyncCallback<void>): void;
异步对指定卷进行格式化，以callback方式返回。 异步对指定卷进行格式化，以callback方式返回。
...@@ -392,23 +390,21 @@ format(volumeId: string, fsType: string, callback: AsyncCallback<boolean>): void ...@@ -392,23 +390,21 @@ format(volumeId: string, fsType: string, callback: AsyncCallback<boolean>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- | | -------- | --------------------------------------- | ---- | ---------------- |
| volumeId | string | 是 | 卷id | | volId | string | 是 | 卷id |
| fsType | string | 是 | 文件系统类型 | | callback | callback:AsyncCallback&lt;void&gt; | 是 | 对指定卷进行格式化 |
| callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 对指定卷进行格式化 |
- 示例 - 示例
```js ```js
let volumeId = ""; let volId = "";
let fsType = ""; volumemanager.format(volumeId, (error, bool) => {
volumemanager.format(volumeId, fsType, (error, bool) => {
// do something // do something
}); });
``` ```
## volumemanager.partition ## volumemanager.partition
partition(diskId: string, type: number): Promise<boolean>; partition(diskId: string, type: number): Promise<void>;
异步对磁盘进行分区，以promise方式返回。 异步对磁盘进行分区，以promise方式返回。
...@@ -420,26 +416,26 @@ partition(diskId: string, type: number): Promise<boolean>; ...@@ -420,26 +416,26 @@ partition(diskId: string, type: number): Promise<boolean>;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------ | ---- | ---- | | ----------- | ------ | ---- | ---- |
| diskId | string | 是 | 卷所属的磁盘id | | volId | string | 是 | 卷所属的磁盘id |
| type | number | 是 | 分区类型 | | fstype | string | 是 | 分区类型 |
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ----------------------- | | --------------------- | ----------------------- |
| Promise&lt;boolean&gt; | 对磁盘进行分区 | | Promise&lt;void&gt; | 对磁盘进行分区 |
- 示例 - 示例
```js ```js
let diskId = ""; let volId = "";
let type = 0; let fstype = "";
let bool = await volumemanager.partition(diskId, type); let bool = await volumemanager.partition(volId, fstype);
``` ```
## volumemanager.partition ## volumemanager.partition
partition(diskId: string, type: number, callback: AsyncCallback<boolean>): void; partition(diskId: string, type: number, callback: AsyncCallback<void>): void;
异步对磁盘进行分区，以callback方式返回。 异步对磁盘进行分区，以callback方式返回。
...@@ -447,20 +443,22 @@ partition(diskId: string, type: number, callback: AsyncCallback<boolean>): void; ...@@ -447,20 +443,22 @@ partition(diskId: string, type: number, callback: AsyncCallback<boolean>): void;
**系统能力**：SystemCapability.FileManagement.StorageService.Volume **系统能力**：SystemCapability.FileManagement.StorageService.Volume
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------------- | | -------- | --------------------------------------- | ---- | ---------------- |
| diskId | string | 是 | 卷所属的磁盘id | | volId | string | 是 | 卷所属的磁盘id |
| type | number | 是 | 分区类型 | | fstype | string | 是 | 分区类型 |
| callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 对磁盘进行分区 | | callback | callback:AsyncCallback&lt;void&gt; | 是 | 对磁盘进行分区 |
- 示例 - 示例
```js ```js
let diskId = ""; let volId = "";
let type = 0; let fstype = "";
volumemanager.format(diskId, type, (error, bool) => { volumemanager.format(volId, fstype, (error, bool) => {
// do something // do something
}); });
``` ```
...@@ -473,10 +471,9 @@ partition(diskId: string, type: number, callback: AsyncCallback<boolean>): void; ...@@ -473,10 +471,9 @@ partition(diskId: string, type: number, callback: AsyncCallback<boolean>): void;
| 名称 | 类型 | 说明 | | 名称 | 类型 | 说明 |
| ----------- | ------- | -------------------- | | ----------- | ------- | -------------------- |
| id | number | 卷id | | id | string | 卷id |
| uuid | string | 卷uuid | | uuid | string | 卷uuid |
| diskId | string | 卷diskId |
| description | string | 卷相关描述 | | description | string | 卷相关描述 |
| removable | boolean | 是否为可移动存储设备 | | removable | boolean | 是否为可移动存储设备 |
| state | int | 当前卷状态 | | state | number | 当前卷状态 |
| path | string | 卷的挂载地址 | | path | string | 卷的挂载地址 |
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或