!3552 add api 9

Merge pull request !3552 from zhangxingxia/OpenHarmony-3.1-Release

zh-cn/application-dev/reference/apis/Readme-CN.md

@@ -92,6 +92,7 @@
   - [@ohos.fileManager (公共文件访问与管理)](js-apis-filemanager.md)
   - [@ohos.statfs (statfs)](js-apis-statfs.md)
   - [@ohos.storageStatistics (应用空间统计)](js-apis-storage-statistics.md)
+  - [@ohos.volumeManager (卷管理)](js-apis-volumemanager.md)
 - 电话服务
 
   - [@ohos.contact (联系人)](js-apis-contact.md)

zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md

@@ -3,7 +3,7 @@
 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
 >
 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-> - 本模块接口为系统接口，三方应用不支持调用。
+> - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。
 
 ## 导入模块
 
@@ -67,6 +67,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
   });
   ```
   
+  
 
 ## storagestatistics.getFreeSizeOfVolume
 
@@ -124,3 +125,71 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo
       console.info("getFreeSizeOfVolume successfully:"+ number);
   });
   ```
+
+## storagestatistics.getBundleStats<sup>9+</sup>
+
+getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
+
+异步获取应用存储数据，以promise方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
+
+- 参数
+
+  | 参数名      | 类型   | 必填 | 说明     |
+  | ----------- | ------ | ---- | -------- |
+  | packageName | string | 是   | 应用包名 |
+  
+- 返回值
+
+  | 类型                                       | 说明                       |
+  | ------------------------------------------ | -------------------------- |
+  | Promise&lt;[Bundlestats](#bundlestats)&gt; | 返回指定卷上的应用存储状态 |
+
+- 示例
+
+  ```js
+  let packageName = "";
+  storagestatistics.getBundleStats(packageName).then(function(BundleStats){
+      console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
+  }).catch(function(err){
+      console.info("getBundleStats failed with error:"+ err);
+  });
+  ```
+
+## storagestatistics.getBundleStats<sup>9+</sup>
+
+getBundleStats(packageName: string,  callback: AsyncCallback&lt;BundleStats&gt;): void
+
+异步获取应用存储数据，以callback方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
+
+- 参数
+
+  | 参数名   | 类型                                                      | 必填 | 说明                                 |
+  | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
+  | packageName | string | 是   | 应用包名 |
+  | callback | callback:AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | 是   | 获取指定卷上的应用存储状态之后的回调 |
+  
+- 示例
+
+  ```js
+  let packageName = "";
+  storagestatistics.getBundleStats(packageName, function(error, BundleStats){
+      // do something
+      console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
+  });
+  ```
+
+## BundleStats<sup>9+</sup>
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
+
+### 属性
+
+| 名称      | 类型   | 说明           |
+| --------- | ------ | -------------- |
+| appSize<sup>9+</sup>   | number | app数据大小    |
+| cacheSize<sup>9+</sup> | number | 缓存数据大小   |
+| dataSize<sup>9+</sup>  | number | 应用总数据大小 |
\ No newline at end of file

zh-cn/application-dev/reference/apis/js-apis-volumemanager.md

+# 卷管理
+
+> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
+>
+> - 本模块首批接口从API version 9开始支持。
+> - API 9当前为Canary版本，仅供试用，不保证接口可稳定调用。
+
+## 导入模块
+
+```js
+import volumemanager from "@ohos.volumeManager";
+```
+
+## volumemanager.getAllVolumes
+
+getAllVolumes(): Promise<Array<Volume>>
+
+异步获取当前所有可获得的卷信息，以promise方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 返回值
+
+  | 类型                               | 说明                       |
+  | ---------------------------------- | -------------------------- |
+  | Promise<[Volume](#volume)[]> | 返回当前所有可获得的卷信息 |
+
+- 示例
+
+  ```js
+  volumemanager.getAllVolumes().then(function(volumes){
+      // do something
+  });
+  ```
+
+## volumemanager.getAllVolumes
+
+getAllVolumes(callback: AsyncCallback<Array<Volume>>): void
+
+异步获取当前所有可获得的卷信息，以callback方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 参数
+
+  | 参数名   | 类型                                              | 必填 | 说明                                 |
+  | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
+  | callback | callback:AsyncCallback<[Volume](#volume)[]> | 是   | 获取当前所有可获得的卷信息之后的回调 |
+  
+- 示例
+
+  ```js
+  let uuid = "";
+  volumemanager.getAllVolumes(uuid, function(error, volumes){
+      // do something
+  });
+  ```
+
+
+## volumemanager.mount
+
+mount(volumeId: string): Promise<boolean>
+
+异步挂载指定卷，以promise方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 参数
+
+  | 参数名   | 类型   | 必填 | 说明 |
+  | -------- | ------ | ---- | ---- |
+  | volumeId | string | 是   | 卷id |
+
+- 返回值
+
+  | 类型                   | 说明       |
+  | ---------------------- | ---------- |
+  | Promise<boolean> | 挂载指定卷 |
+
+- 示例
+
+  ```js
+  let volumeId = "";
+  volumemanager.mount(volumeId).then(function(flag){
+      // do something
+  });
+  ```
+
+## volumemanager.mount
+
+mount(volumeId: string, callback:AsyncCallback<boolean>):void
+
+异步获取指定卷的可用空间大小，以callback方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 参数
+
+  | 参数名   | 类型                                  | 必填 | 说明                 |
+  | -------- | ------------------------------------- | ---- | -------------------- |
+  | volumeId | string                                | 是   | 卷id                 |
+  | callback | callback:AsyncCallback<boolean> | 是   | 挂载指定卷之后的回调 |
+
+- 示例
+
+  ```js
+  let volumeId = "";
+  volumemanager.mount(volumeId, function(error, flag){
+      // do something
+  });
+  ```
+
+## volumemanager.unmount
+
+unmount(volumeId: string): Promise<boolean>
+
+异步卸载指定卷，以promise方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 参数
+
+  | 参数名   | 类型   | 必填 | 说明 |
+  | -------- | ------ | ---- | ---- |
+  | volumeId | string | 是   | 卷id |
+
+- 返回值
+
+  | 类型                   | 说明       |
+  | ---------------------- | ---------- |
+  | Promise<boolean> | 卸载指定卷 |
+
+- 示例
+
+  ```js
+  let volumeId = "";
+  volumemanager.unmount(volumeId).then(function(flag){
+      // do something
+  });
+  ```
+
+## volumemanager.unmount
+
+unmount(volumeId: string, callback:AsyncCallback<boolean>):void
+
+异步卸载指定卷，以callback方式返回。
+
+**系统能力**：SystemCapability.FileManagement.StorageService.Volume
+
+- 参数
+
+  | 参数名   | 类型                                  | 必填 | 说明                 |
+  | -------- | ------------------------------------- | ---- | -------------------- |
+  | volumeId | string                                | 是   | 卷id                 |
+  | callback | callback:AsyncCallback<boolean> | 是   | 卸载指定卷之后的回调 |
+
+- 示例
+
+  ```js
+  let volumeId = "";
+  volumemanager.unmount(volumeId, function(error, flag){
+      // do something
+  });
+  ```
+
+## Volume
+
+**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。
+
+### 属性
+
+| 名称        | 类型    | 说明                 |
+| ----------- | ------- | -------------------- |
+| id          | number  | 卷id                 |
+| uuid        | string  | 卷uuid               |
+| description | string  | 卷相关描述           |
+| removable | boolean | 是否为可移动存储设备 |
+| state       | int     | 当前卷状态           |
+| path        | string  | 卷的挂载地址         |
\ No newline at end of file