提交 1fbbc31a 编写于 作者: Z zhangxingxia

update apis

Signed-off-by: Nzhangxingxia <zhangxingxia1@huawei.com>
上级 1fadcd37
# 应用空间统计 # 应用空间统计
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本
## 导入模块 ## 导入模块
...@@ -15,7 +15,7 @@ SystemCapability.FileManagement.StorageService.SpatialStatistics ...@@ -15,7 +15,7 @@ SystemCapability.FileManagement.StorageService.SpatialStatistics
## storagestatistics.getTotalSizeOfVolume ## storagestatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string): Promise\<number\> getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
异步获取指定卷的总空间大小,以promise方式返回。 异步获取指定卷的总空间大小,以promise方式返回。
...@@ -27,31 +27,33 @@ getTotalSizeOfVolume(volumeUuid: string): Promise\<number\> ...@@ -27,31 +27,33 @@ getTotalSizeOfVolume(volumeUuid: string): Promise\<number\>
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ---------------- | | --------------------- | ---------------- |
| Promise\<number\> | 返回指定卷总空间 | | Promise&lt;number&gt; | 返回指定卷总空间 |
- 示例 - 示例
```js ```js
let uuid = ""; let uuid = "";
storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){ storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){
// do something console.info("getTotalSizeOfVolume successfully:"+ number);
}).catch(function(err){
console.info("getTotalSizeOfVolume failed with error:"+ err);
}); });
``` ```
## storagestatistics.getTotalSizeOfVolume ## storagestatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void
异步获取指定卷的总空间大小,以callback方式返回。 异步获取指定卷的总空间大小,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------- | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| volumeUuid | string | 是 | 卷id | | volumeUuid | string | 是 | 卷id |
| callback | callback:AsyncCallback\<number\> | 是 | 获取指定卷总空间之后的回调 | | callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取指定卷总空间之后的回调 |
- 示例 - 示例
...@@ -66,7 +68,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void ...@@ -66,7 +68,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void
## storagestatistics.getFreeSizeOfVolume ## storagestatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string): Promise\<number\> getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
异步获取指定卷的可用空间大小,以promise方式返回。 异步获取指定卷的可用空间大小,以promise方式返回。
...@@ -78,31 +80,34 @@ getFreeSizeOfVolume(volumeUuid: string): Promise\<number\> ...@@ -78,31 +80,34 @@ getFreeSizeOfVolume(volumeUuid: string): Promise\<number\>
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ----------------- | ------------------ | | --------------------- | ------------------ |
| Promise\<number\> | 返回指定卷可用空间 | | Promise&lt;number&gt; | 返回指定卷可用空间 |
- 示例 - 示例
```js ```js
let uuid = ""; let uuid = "";
storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){ storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){
// do something console.info("getFreeSizeOfVolume successfully:"+ number);
}).catch(function(err){
console.info("getFreeSizeOfVolume failed with error:"+ err);
}); });
``` ```
## storagestatistics.getFreeSizeOfVolume ## storagestatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback&lt;number&gt;):void
异步获取指定卷的可用空间大小,以callback方式返回。 异步获取指定卷的可用空间大小,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | -------------------------------- | ---- | ---------------------------- | | ---------- | ------------------------------------ | ---- | ---------------------------- |
| volumeUuid | string | 是 | 卷id | | volumeUuid | string | 是 | 卷id |
| callback | callback:AsyncCallback\<number\> | 是 | 获取指定卷可用空间之后的回调 | | callback | callback:AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 |
- 示例 - 示例
...@@ -115,7 +120,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void ...@@ -115,7 +120,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\<number\>):void
## storagestatistics.getBundleStats ## storagestatistics.getBundleStats
getBundleStats(volumeUuid: string, packageName:String, ): Promise\<BundleStats\> getBundleStats(volumeUuid: string, packageName:String, ): Promise&lt;BundleStats&gt;
异步获取指定卷上的应用存储状态,以promise方式返回。 异步获取指定卷上的应用存储状态,以promise方式返回。
...@@ -138,22 +143,24 @@ getBundleStats(volumeUuid: string, packageName:String, ): Promise\<BundleStats\ ...@@ -138,22 +143,24 @@ getBundleStats(volumeUuid: string, packageName:String, ): Promise\<BundleStats\
let uuid = ""; let uuid = "";
let packageName = ""; let packageName = "";
storagestatistics.getBundleStats(uuid, packageName).then(function(BundleStats){ storagestatistics.getBundleStats(uuid, packageName).then(function(BundleStats){
// do something console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
}).catch(function(err){
console.info("getBundleStats failed with error:"+ err);
}); });
``` ```
## storagestatistics.getBundleStats ## storagestatistics.getBundleStats
getBundleStats(volumeUuid: string, callback:AsyncCallback\<BundleStats\>):void getBundleStats(volumeUuid: string, callback:AsyncCallback&lt;BundleStats&gt;):void
异步获取指定卷上的应用存储状态,以callback方式返回。 异步获取指定卷上的应用存储状态,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ---------- | ----------------------------------------------------- | ---- | ------------------------------------ | | ---------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| volumeUuid | string | 是 | 卷id | | volumeUuid | string | 是 | 卷id |
| callback | callback:AsyncCallback\<[Bundlestats](#bundlestats)\> | 是 | 获取指定卷上的应用存储状态之后的回调 | | callback | callback:AsyncCallback&lt;[Bundlestats](#bundlestats)&gt; | 是 | 获取指定卷上的应用存储状态之后的回调 |
- 示例 - 示例
......
# 卷管理 # 卷管理
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:** > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本 > 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本
## 导入模块 ## 导入模块
...@@ -15,15 +15,15 @@ SystemCapability.FileManagement.StorageService.Volume ...@@ -15,15 +15,15 @@ SystemCapability.FileManagement.StorageService.Volume
## volumemanager.getAllVolumes ## volumemanager.getAllVolumes
getAllVolumes(): Promise\<Volume[]\> getAllVolumes(): Promise&lt;Volume[]&gt;
异步获取当前所有可获得的卷信息,以promise方式返回。 异步获取当前所有可获得的卷信息,以promise方式返回。
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------ | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise\<[Volume](#volume)[]\> | 返回当前所有可获得的卷信息 | | Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷信息 |
- 示例 - 示例
...@@ -35,15 +35,15 @@ getAllVolumes(): Promise\<Volume[]\> ...@@ -35,15 +35,15 @@ getAllVolumes(): Promise\<Volume[]\>
## volumemanager.getAllVolumes ## volumemanager.getAllVolumes
getAllVolumes(callback:AsyncCallback\<Volume[]\>):void getAllVolumes(callback:AsyncCallback&lt;Volume[]&gt;):void
异步获取当前所有可获得的卷信息,以callback方式返回。 异步获取当前所有可获得的卷信息,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------- | ---- | ------------------------------------ | | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | callback:AsyncCallback\<[Volume](#volume)[]\> | 是 | 获取当前所有可获得的卷信息之后的回调 | | callback | callback:AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷信息之后的回调 |
- 示例 - 示例
...@@ -57,7 +57,7 @@ getAllVolumes(callback:AsyncCallback\<Volume[]\>):void ...@@ -57,7 +57,7 @@ getAllVolumes(callback:AsyncCallback\<Volume[]\>):void
## volumemanager.mount ## volumemanager.mount
mount(volumeId: string): Promise\<boolean\> mount(volumeId: string): Promise&lt;boolean&gt;
异步挂载指定卷,以promise方式返回。 异步挂载指定卷,以promise方式返回。
...@@ -69,9 +69,9 @@ mount(volumeId: string): Promise\<boolean\> ...@@ -69,9 +69,9 @@ mount(volumeId: string): Promise\<boolean\>
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ------------------ | ---------- | | ---------------------- | ---------- |
| Promise\<boolean\> | 挂载指定卷 | | Promise&lt;boolean&gt; | 挂载指定卷 |
- 示例 - 示例
...@@ -84,16 +84,16 @@ mount(volumeId: string): Promise\<boolean\> ...@@ -84,16 +84,16 @@ mount(volumeId: string): Promise\<boolean\>
## volumemanager.mount ## volumemanager.mount
mount(volumeId: string, callback:AsyncCallback\<boolean\>):void mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
异步获取指定卷的可用空间大小,以callback方式返回。 异步获取指定卷的可用空间大小,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback\<boolean\> | 是 | 挂载指定卷之后的回调 | | callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 挂载指定卷之后的回调 |
- 示例 - 示例
...@@ -106,7 +106,7 @@ mount(volumeId: string, callback:AsyncCallback\<boolean\>):void ...@@ -106,7 +106,7 @@ mount(volumeId: string, callback:AsyncCallback\<boolean\>):void
## volumemanager.unmount ## volumemanager.unmount
unmount(volumeId: string): Promise\<boolean\> unmount(volumeId: string): Promise&lt;boolean&gt;
异步卸载指定卷,以promise方式返回。 异步卸载指定卷,以promise方式返回。
...@@ -118,9 +118,9 @@ unmount(volumeId: string): Promise\<boolean\> ...@@ -118,9 +118,9 @@ unmount(volumeId: string): Promise\<boolean\>
- 返回值 - 返回值
| 类型 | 说明 | | 类型 | 说明 |
| ------------------ | ---------- | | ---------------------- | ---------- |
| Promise\<boolean\> | 卸载指定卷 | | Promise&lt;boolean&gt; | 卸载指定卷 |
- 示例 - 示例
...@@ -133,16 +133,16 @@ unmount(volumeId: string): Promise\<boolean\> ...@@ -133,16 +133,16 @@ unmount(volumeId: string): Promise\<boolean\>
## volumemanager.unmount ## volumemanager.unmount
unmount(volumeId: string, callback:AsyncCallback\<boolean\>):void unmount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
异步卸载指定卷,以callback方式返回。 异步卸载指定卷,以callback方式返回。
- 参数 - 参数
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------- | ---- | -------------------- | | -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id | | volumeId | string | 是 | 卷id |
| callback | callback:AsyncCallback\<boolean\> | 是 | 卸载指定卷之后的回调 | | callback | callback:AsyncCallback&lt;boolean&gt; | 是 | 卸载指定卷之后的回调 |
- 示例 - 示例
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册