!2718 delete api9

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

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

@@ -111,7 +111,6 @@
   - [@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-fileio.md

@@ -1377,8 +1377,8 @@ readTextSync(filePath: string, options?: {
 
 - 返回值：
   | 类型   | 说明                 |
-  | --------------------- | ---------- |
-  | Promise<string> | 返回读取文件的内容。 |
+  | ------ | -------------------- |
+  | string | 返回读取文件的内容。 |
 
 - 示例：
   ```js
@@ -1533,9 +1533,9 @@ rename(oldPath: string, newPath: string): Promise<void>
 
 - 参数：
   | 参数名  | 类型   | 必填 | 说明                     |
-  | ------- | ------ | ---- | ------------ |
+  | ------- | ------ | ---- | ------------------------ |
   | oldPath | string | 是   | 目标文件的当前绝对路径。 |
-  | Newpath | String | 是    | 目标文件的新绝对路径。  |
+  | newPath | String | 是   | 目标文件的新绝对路径。   |
 
 - 返回值：
   | 类型                  | 说明                           |
@@ -1544,7 +1544,7 @@ rename(oldPath: string, newPath: string): Promise<void>
 
 - 示例：
   ```js
-  fileio.rename(oldPath, Newpath).then(function() {
+  fileio.rename(oldPath, newPath).then(function() {
       console.info("rename successfully");
   }).catch(function(err){
       console.info("rename failed with error:"+ err);
@@ -1563,13 +1563,13 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v
 - 参数：
   | 参数名      | 类型                        | 必填   | 说明            |
   | -------- | ------------------------- | ---- | ------------- |
-  | oldpath  | string                    | 是    | 目标文件的当前绝对路径。  |
-  | Newpath  | String                    | 是    | 目标文件的新绝对路径。   |
+  | oldPath  | string                    | 是    | 目标文件的当前绝对路径。  |
+  | newPath  | String                    | 是    | 目标文件的新绝对路径。   |
   | Callback | AsyncCallback<void> | 是    | 异步重命名文件之后的回调。 |
 
 - 示例：
   ```js
-  fileio.rename(oldpath, Newpath, function(err){
+  fileio.rename(oldPath, newPath, function(err){
   });
   ```
 
@@ -1586,11 +1586,11 @@ renameSync(oldPath: string, newPath: string): void
   | 参数名     | 类型     | 必填   | 说明           |
   | ------- | ------ | ---- | ------------ |
   | oldPath | string | 是    | 目标文件的当前绝对路径。 |
-  | Newpath | String | 是    | 目标文件的新绝对路径。  |
+  | newPath | String | 是    | 目标文件的新绝对路径。  |
 
 - 示例：
   ```js
-  fileio.renameSync(oldpath, newpath);
+  fileio.renameSync(oldPath, newPath);
   ```
 
 

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

@@ -21,7 +21,7 @@ getRoot(options? : {dev? : DevInfo}) : Promise<FileInfo[]>
 - 参数
   | 参数名 | 类型 | 必填 | 说明 |
   | --- | --- | --- | -- |
-  | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
 
 - 返回值
 
@@ -31,17 +31,17 @@ getRoot(options? : {dev? : DevInfo}) : Promise&lt;FileInfo[]&gt;
 
 - 示例
 
-```js
-filemanager.getRoot().then((fileInfo) => {
+  ```js
+  filemanager.getRoot().then((fileInfo) => {
       if(Array.isArray(fileInfo)) {
           for (var i = 0; i < fileInfo.length; i++) {
               console.log(JSON.Stringify(fileInfo))
           }
       }
-}).catch((err) => {
+  }).catch((err) => {
       console.log(err)
-});
-```
+  });
+  ```
 
 ## filemanager.getRoot
 
@@ -55,20 +55,20 @@ getRoot(options? : {dev? : DevInfo}, callback : AsyncCallback&lt;FileInfo[]&gt;)
 
   | 参数名   | 类型                      | 必填 | 说明                          |
   | -------- | ------------------------- | ---- | ----------------------------- |
-  | dev      | [DevInfo](#devinfo)              | 否   | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
   | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是   | 异步获取文件的信息之后的回调  |
 
 - 示例
 
-```js
-filemanager.getRoot((err, fileInfo) => {
+  ```js
+  filemanager.getRoot((err, fileInfo) => {
       if(Array.isArray(fileInfo)) {
           for (var i = 0; i < fileInfo.length; i++) {
               console.log(JSON.Stringify(fileInfo))
           }
       }
-})
-```
+  });
+  ```
 
 ## filemanager.listFile
 
@@ -81,11 +81,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
 - 参数
   | 参数名 | 类型 | 必填 | 说明 |
   | --- | --- | --- | -- |
-  | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
   | path | string | 是 | 待查询目录uri |
-  | dev | [DevInfo](#devinfo) | 是 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
-  | offset | number | 否 | 待查询文件偏移 |
-  | count | number | 否 | 待查询文件个数 |
+  | type | string | 是 | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local'。<br/>-&nbsp;offset，number类型，待查询文件偏移个数。<br/>-&nbsp;count，number类型，待查询文件个数。 |
   
 - 返回值
 
@@ -100,21 +98,24 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
   | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
   | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
 
-```js
-// 获取目录下所有文件
-// 通过listFile、getRoot获取的文件uri
-let media_path = file.uri
-filemanager.listFile(media_path, "file")
-.then((fileInfo) => {
+- 示例
+
+  ```js
+  // 获取目录下所有文件
+  // 通过listFile、getRoot获取的文件uri
+  let media_path = file.uri
+  filemanager.listFile(media_path, "file")
+  .then((fileInfo) => {
       if(Array.isArray(fileInfo)) {
           for (var i = 0; i < fileInfo.length; i++) {
               console.log(JSON.Stringify(fileInfo))
           }
       }
-}).catch((err) => {
+  }).catch((err) => {
       console.log(err)
-})
-```
+  });
+  ```
+
 ## filemanager.listFile
 
 listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : number, count? : number}, callback : AsyncCallback&lt;FileInfo[]&gt;) : void
@@ -127,11 +128,9 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
 
   | 参数名   | 类型                      | 必填 | 说明                                                         |
   | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
-  | type     | string                    | 是   | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
   | path     | string                    | 是   | 待查询目录uri                                                |
-  | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
-  | offset | number | 否 | 待查询文件偏移 |
-  | count | number | 否 | 待查询文件个数 |
+  | type     | string                    | 是   | 待查询文件类型, 支持以下类型 "file", "image", "audio", "video" |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local'。<br/>-&nbsp;offset，number类型，待查询文件偏移个数。<br/>-&nbsp;count，number类型，待查询文件个数。 |
   | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是   | 异步获取文件的信息之后的回调                                 |
 - 异常
 
@@ -141,21 +140,23 @@ listFile(path : string, type : string, options? : {dev? : DevInfo, offset? : num
   | 获取FMS服务失败           | No such process           | 3      | 获取FMS服务失败           |
   | path对应uri不是相册、目录 | Not a directory           | 20     | path对应uri不是相册、目录 |
 
-```js
-// 通过listFile、getRoot获取的文件uri
-let media_path = file.uri
-filemanager.listFile(media_path, "file", (err, fileInfo) => {
+- 示例
+
+  ```js
+  // 通过listFile、getRoot获取的文件uri
+  let media_path = file.uri
+  filemanager.listFile(media_path, "file", (err, fileInfo) => {
       if(Array.isArray(fileInfo)) {
           for (var i = 0; i < fileInfo.length; i++) {
               console.log(JSON.Stringify(fileInfo))
           }
       }
-})
-```
+  });
+  ```
 
 ## filemanager.createFile
 
-filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo})  :   promise&lt;string&gt;
+filemanager.createFile(path : string, filename : string, options? : {dev? : DevInfo})  :   Promise&lt;string&gt;
 
 以异步方法创建文件到指定路径，返回文件uri。使用promise形式返回结果。
 
@@ -166,7 +167,7 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
   | --- | --- | --- | -- |
   | filename | string | 是 | 待创建的文件名 |
   | path | string | 是 | 待保存目的相册uri |
-  | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
 
 - 返回值
 
@@ -182,18 +183,20 @@ filemanager.createFile(path : string, filename : string, options? : {dev? : DevI
   | 获取FMS服务失败 | No such process | 3 | 获取FMS服务失败 |
   | path对应uri不是相册、目录 | Not a directory | 20 | path对应uri不是相册、目录 |
 
-```js
-// 创建文件，返回文件uri
-let media_path = file.uri // 通过listFile、getRoot获取的文件uri
-let name = "xxx.jpg" // 待保存文件的后缀
-filemanager.createFile(media_path, name)
-.then((uri) => {
-// 返回uri给应用
-})
-.catch((err) => {
+- 示例
+
+  ```js
+  // 创建文件，返回文件uri
+  let media_path = file.uri // 通过listFile、getRoot获取的文件uri
+  let name = "xxx.jpg" // 待保存文件的后缀
+  filemanager.createFile(media_path, name)
+  .then((uri) => {
+  // 返回uri给应用
+  })
+  .catch((err) => {
       console.log(err)
-})
-```
+  });
+  ```
 
 ## filemanager.createFile
 
@@ -209,7 +212,7 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
   | -------- | ------------------------- | ---- | ----------------------------- |
   | filename | string                    | 是   | 待创建的文件名                |
   | path     | string                    | 是   | 待保存目的相册uri             |
-  | dev | [DevInfo](#devinfo) | 否 | 设备名, 不填为默认值dev = {name: "local"}, 当前仅支持设备'local' |
+  | options | Object | 否 | 支持如下选项：<br/>-&nbsp;dev，[DevInfo](#devinfo)类型，不填默认dev = {name: "local"}, 当前仅支持设备'local' |
   | callback | AsyncCallback&lt;[FileInfo](#fileinfo)[]&gt; | 是   | 异步获取文件的信息之后的回调  |
 
 - 异常
@@ -221,16 +224,18 @@ createFile(path : string, filename: string, options? : {dev? : DevInfo}, callbac
   | 获取FMS服务失败           | No such process           | 3      | 获取FMS服务失败           |
   | path对应uri不是相册、目录 | Not a directory           | 20     | path对应uri不是相册、目录 |
 
-```js
-// 创建文件，返回文件uri
-// 通过listFile、getRoot获取的文件uri
-let media_path = file.uri
-// 待保存文件的后缀
-let name = "xxx.jpg"
-filemanager.createFile(media_path, name, (err, uri) => {
-// 返回uri给应用
-})
-```
+- 示例
+
+  ```js
+  // 创建文件，返回文件uri
+  // 通过listFile、getRoot获取的文件uri
+  let media_path = file.uri
+  // 待保存文件的后缀
+  let name = "xxx.jpg"
+  filemanager.createFile(media_path, name, (err, uri) => {
+  // 返回uri给应用
+  });
+  ```
 
 ## FileInfo
 文件信息类型，通过getRoot, listFile等接口返回的类型。
@@ -249,12 +254,13 @@ filemanager.createFile(media_path, name, (err, uri) => {
 | modifiedTime | number | 是 | 否 | 媒体修改时间 |
 
 ## DevInfo
+
 设备类型，配置接口访问的设备类型。
 
 **系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.FileManagerService。
 
 ### 属性
 
-  | 参数名 | 类型 | 可读 | 可写 | 说明 |
-  | --- | -- | -- | -- | -- |
-  | name | string | 是 | 是 | 设备名称 |
\ No newline at end of file
+| 参数名 | 类型   | 可读 | 可写 | 说明     |
+| ------ | ------ | ---- | ---- | -------- |
+| name   | string | 是   | 是   | 设备名称 |
\ No newline at end of file

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

@@ -68,7 +68,6 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v
   ```
   
 
-
 ## storagestatistics.getFreeSizeOfVolume
 
 getFreeSizeOfVolume(volumeUuid: string): Promise<number>
@@ -125,71 +124,3 @@ 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 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
-> - 此接口为系统接口，三方应用不支持调用。
-
-## 导入模块
-
-```js
-import volumemanager from "@ohos.volumeManager";
-```
-
-## volumemanager.getAllVolumes<sup>9+</sup>
-
-getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;
-
-异步获取当前所有可获得的卷信息，以promise方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 返回值
-
-  | 类型                               | 说明                       |
-  | ---------------------------------- | -------------------------- |
-  | Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷信息 |
-
-- 示例
-
-  ```js
-  volumemanager.getAllVolumes().then(function(volumes){
-      // do something
-  });
-  ```
-
-## volumemanager.getAllVolumes<sup>9+</sup>
-
-getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
-
-异步获取当前所有可获得的卷信息，以callback方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 参数
-
-  | 参数名   | 类型                                              | 必填 | 说明                                 |
-  | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
-  | callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是   | 获取当前所有可获得的卷信息之后的回调 |
-  
-- 示例
-
-  ```js
-  let uuid = "";
-  volumemanager.getAllVolumes(uuid, function(error, volumes){
-      // do something
-  });
-  ```
-
-
-## volumemanager.mount<sup>9+</sup>
-
-mount(volumeId: string): Promise&lt;boolean&gt;
-
-异步挂载指定卷，以promise方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 参数
-
-  | 参数名   | 类型   | 必填 | 说明 |
-  | -------- | ------ | ---- | ---- |
-  | volumeId | string | 是   | 卷id |
-
-- 返回值
-
-  | 类型                   | 说明       |
-  | ---------------------- | ---------- |
-  | Promise&lt;boolean&gt; | 挂载指定卷 |
-
-- 示例
-
-  ```js
-  let volumeId = "";
-  volumemanager.mount(volumeId).then(function(flag){
-      // do something
-  });
-  ```
-
-## volumemanager.mount<sup>9+</sup>
-
-mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
-
-异步获取指定卷的可用空间大小，以callback方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 参数
-
-  | 参数名   | 类型                                  | 必填 | 说明                 |
-  | -------- | ------------------------------------- | ---- | -------------------- |
-  | volumeId | string                                | 是   | 卷id                 |
-  | callback | callback:AsyncCallback&lt;boolean&gt; | 是   | 挂载指定卷之后的回调 |
-
-- 示例
-
-  ```js
-  let volumeId = "";
-  volumemanager.mount(volumeId, function(error, flag){
-      // do something
-  });
-  ```
-
-## volumemanager.unmount<sup>9+</sup>
-
-unmount(volumeId: string): Promise&lt;boolean&gt;
-
-异步卸载指定卷，以promise方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 参数
-
-  | 参数名   | 类型   | 必填 | 说明 |
-  | -------- | ------ | ---- | ---- |
-  | volumeId | string | 是   | 卷id |
-
-- 返回值
-
-  | 类型                   | 说明       |
-  | ---------------------- | ---------- |
-  | Promise&lt;boolean&gt; | 卸载指定卷 |
-
-- 示例
-
-  ```js
-  let volumeId = "";
-  volumemanager.unmount(volumeId).then(function(flag){
-      // do something
-  });
-  ```
-
-## volumemanager.unmount<sup>9+</sup>
-
-unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
-
-异步卸载指定卷，以callback方式返回。
-
-**系统能力**：SystemCapability.FileManagement.StorageService.Volume
-
-- 参数
-
-  | 参数名   | 类型                                  | 必填 | 说明                 |
-  | -------- | ------------------------------------- | ---- | -------------------- |
-  | volumeId | string                                | 是   | 卷id                 |
-  | callback | callback:AsyncCallback&lt;boolean&gt; | 是   | 卸载指定卷之后的回调 |
-
-- 示例
-
-  ```js
-  let volumeId = "";
-  volumemanager.unmount(volumeId, function(error, flag){
-      // do something
-  });
-  ```
-
-## Volume<sup>9+</sup>
-
-**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.Volume。
-
-### 属性
-
-| 名称        | 类型    | 说明                 |
-| ----------- | ------- | -------------------- |
-| id<sup>9+</sup>          | number  | 卷id                 |
-| uuid<sup>9+</sup>        | string  | 卷uuid               |
-| description<sup>9+</sup> | string  | 卷相关描述           |
-| removable<sup>9+</sup> | boolean | 是否为可移动存储设备 |
-| state<sup>9+</sup>       | int     | 当前卷状态           |
-| path<sup>9+</sup>        | string  | 卷的挂载地址         |
\ No newline at end of file