update docs

Signed-off-by: N annie_wangli <annie.wangli@huawei.com>

update docs
Signed-off-by: N annie_wangli <annie.wangli@huawei.com>
cb580934 · annie_wangli · 4662fd8a · cb580934
隐藏空白更改
内联并排

Showing with 50 addition and 39 deletion

en/application-dev/reference/apis/js-apis-volumemanager.md en/application-dev/reference/apis/js-apis-volumemanager.md +50 -39

未找到文件。
--- a/en/application-dev/reference/apis/js-apis-volumemanager.md
+++ b/en/application-dev/reference/apis/js-apis-volumemanager.md
 # Volume Management

-> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE**<br/>
 >
-> The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+> - The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.
+> - This is a system API and cannot be called by third-party applications.

 ## Modules to Import

 ```js
-import volumemanager from "@ohos.volumemanager";
+import volumemanager from "@ohos.volumeManager";
 ```

-## System Capabilities
+## volumemanager.getAllVolumes<sup>9+</sup>

-SystemCapability.FileManagement.StorageService.Volume
-
-## volumemanager.getAllVolumes
-
-getAllVolumes(): Promise&lt;Volume[]&gt;
+getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;

 Asynchronously obtains information about all available volumes. This method uses a promise to return the result.

+**System capability**: SystemCapability.FileManagement.StorageService.Volume
+
 - Return value

-  | Type| Description|
+  | Type                              | Description                      |
  | ---------------------------------- | -------------------------- |
  | Promise&lt;[Volume](#volume)[]&gt; | Promise used to return the execution result.|

@@ -34,17 +33,19 @@ Asynchronously obtains information about all available volumes. This method uses
  });
  ```

-## volumemanager.getAllVolumes
+## volumemanager.getAllVolumes<sup>9+</sup>

-getAllVolumes(callback:AsyncCallback&lt;Volume[]&gt;):void
+getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void

 Asynchronously obtains information about all available volumes. This method uses a callback to return the result.

+**System capability**: SystemCapability.FileManagement.StorageService.Volume
+
 - Parameters

-  | Name| Type| Mandatory| Description|
+  | Name  | Type                                             | Mandatory| Description                                |
  | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
-  | callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | Yes| Callback invoked to return the volume information obtained.|
+  | callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | Yes  | Callback invoked to return the volume information obtained.|
  
 - Example

@@ -56,21 +57,23 @@ Asynchronously obtains information about all available volumes. This method uses
  ```


-## volumemanager.mount
+## volumemanager.mount<sup>9+</sup>

 mount(volumeId: string): Promise&lt;boolean&gt;

 Asynchronously mounts a volume. This method uses a promise to return the result.

+**System capability**: SystemCapability.FileManagement.StorageService.Volume
+
 - Parameters

-  | Name| Type| Mandatory| Description|
+  | Name  | Type  | Mandatory| Description|
  | -------- | ------ | ---- | ---- |
-  | volumeId | string | Yes| Volume ID.|
+  | volumeId | string | Yes  | Volume ID.|

 - Return value

-  | Type| Description|
+  | Type                  | Description      |
  | ---------------------- | ---------- |
  | Promise&lt;boolean&gt; | Promise used to return the execution result.|

@@ -83,18 +86,20 @@ Asynchronously mounts a volume. This method uses a promise to return the result.
  });
  ```

-## volumemanager.mount
+## volumemanager.mount<sup>9+</sup>

 mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void

-Asynchronously mounts a volume. This method uses a callback to return the result.
+Asynchronously obtains the available space of the specified volume. This method uses a callback to return the result.
+
+**System capability**: SystemCapability.FileManagement.StorageService.Volume

 - Parameters

-  | Name| Type| Mandatory| Description|
+  | Name  | Type                                 | Mandatory| Description                |
  | -------- | ------------------------------------- | ---- | -------------------- |
-  | volumeId | string                                | Yes| Volume ID.|
-  | callback | callback:AsyncCallback&lt;boolean&gt; | Yes| Callback invoked to return the execution result.|
+  | volumeId | string                                | Yes  | Volume ID.                |
+  | callback | callback:AsyncCallback&lt;boolean&gt; | Yes  | Callback invoked to return the execution result.|

 - Example

@@ -105,21 +110,23 @@ Asynchronously mounts a volume. This method uses a callback to return the result
  });
  ```

-## volumemanager.unmount
+## volumemanager.unmount<sup>9+</sup>

 unmount(volumeId: string): Promise&lt;boolean&gt;

 Asynchronously unmounts a volume. This method uses a promise to return the result.

+**System capability**: SystemCapability.FileManagement.StorageService.Volume
+
 - Parameters

-  | Name| Type| Mandatory| Description|
+  | Name  | Type  | Mandatory| Description|
  | -------- | ------ | ---- | ---- |
-  | volumeId | string | Yes| Volume ID.|
+  | volumeId | string | Yes  | Volume ID.|

 - Return value

-  | Type| Description|
+  | Type                  | Description      |
  | ---------------------- | ---------- |
  | Promise&lt;boolean&gt; | Promise used to return the execution result.|

@@ -132,18 +139,20 @@ Asynchronously unmounts a volume. This method uses a promise to return the resul
  });
  ```

-## volumemanager.unmount
+## volumemanager.unmount<sup>9+</sup>

 unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void

 Asynchronously unmounts a volume. This method uses a callback to return the result.

+**System capability**: SystemCapability.FileManagement.StorageService.Volume
+
 - Parameters

-  | Name| Type| Mandatory| Description|
+  | Name  | Type                                 | Mandatory| Description                |
  | -------- | ------------------------------------- | ---- | -------------------- |
-  | volumeId | string                                | Yes| Volume ID.|
-  | callback | callback:AsyncCallback&lt;boolean&gt; | Yes| Callback invoked to return the execution result.|
+  | volumeId | string                                | Yes  | Volume ID.                |
+  | callback | callback:AsyncCallback&lt;boolean&gt; | Yes  | Callback invoked to return the execution result.|

 - Example

@@ -154,15 +163,17 @@ Asynchronously unmounts a volume. This method uses a callback to return the resu
  });
  ```

-## Volume
+## Volume<sup>9+</sup>
+
+**System capability**: SystemCapability.FileManagement.StorageService.Volume

 ### Attributes

-| Name| Type| Description|
+| Name       | Type   | Description                |
 | ----------- | ------- | -------------------- |
-| id          | number  | Volume ID.|
-| uuid        | string  | Universally unique identifier (UUID) of the volume.|
-| description | string  | Description of the volume.|
-| removeAble  | boolean | Whether the volume is a removable storage device.|
-| state       | int     | Current volume status.|
-| path        | string  | Mount address of the volume.|
+| id<sup>9+</sup>          | number  | Volume ID.                |
+| uuid<sup>9+</sup>        | string  | Universally unique identifier (UUID) of the volume.              |
+| description<sup>9+</sup> | string  | Description of the volume.          |
+| removable<sup>9+</sup> | boolean | Whether the volume is a removable storage device.|
+| state<sup>9+</sup>       | int     | Current volume status.          |
+| path<sup>9+</sup>        | string  | Mount address of the volume.        |