From 1fadcd374ca6ec4be6412ba6cb7dc067cb7e6c5e Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Fri, 11 Feb 2022 18:02:54 +0800 Subject: [PATCH] add volumemanager and storagestatistics api Signed-off-by: zhangxingxia --- .../reference/apis/Readme-CN.md | 2 + .../apis/js-apis-storage-statistics.md | 176 ++++++++++++++++++ .../reference/apis/js-apis-volumemanager.md | 167 +++++++++++++++++ 3 files changed, 345 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md create mode 100644 zh-cn/application-dev/reference/apis/js-apis-volumemanager.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index c26de29843..fbe27929e9 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -33,6 +33,8 @@ - [Statfs](js-apis-statfs.md) - [目录环境](js-apis-environment.md) - [公共文件访问与管理](js-apis-filemanager.md) + - [应用空间统计](js-apis-storage-statistics.md) + - [卷管理](js-apis-volumemanager.md) - 账号管理 - [分布式帐号管理](js-apis-distributed-account.md) - [应用帐号管理](js-apis-appAccount.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md new file mode 100644 index 0000000000..1b121d5129 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md @@ -0,0 +1,176 @@ +# 应用空间统计 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本 + +## 导入模块 + +```js +import storagestatistics from "@ohos.storagestatistics"; +``` + +## 系统能力 + +SystemCapability.FileManagement.StorageService.SpatialStatistics + +## storagestatistics.getTotalSizeOfVolume + +getTotalSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的总空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ---------------- | + | Promise\ | 返回指定卷总空间 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){ + // do something + }); + ``` + +## storagestatistics.getTotalSizeOfVolume + +getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷的总空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | -------------------------------- | ---- | -------------------------- | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 获取指定卷总空间之后的回调 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + + + +## storagestatistics.getFreeSizeOfVolume + +getFreeSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的可用空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ------------------ | + | Promise\ | 返回指定卷可用空间 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){ + // do something + }); + ``` + +## storagestatistics.getFreeSizeOfVolume + +getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷的可用空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | -------------------------------- | ---- | ---------------------------- | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 获取指定卷可用空间之后的回调 | + +- 示例 + + ```js + let uuid = ""; + storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + +## storagestatistics.getBundleStats + +getBundleStats(volumeUuid: string, packageName:String, ): Promise\ + +异步获取指定卷上的应用存储状态，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ----------- | ------ | ---- | -------- | + | volumeUuid | string | 是 | 卷id | + | packageName | string | 是 | 应用包名 | + +- 返回值 + + | 类型 | 说明 | + | ------------------------------------------ | -------------------------- | + | Promise<[Bundlestats](#bundlestats)> | 返回指定卷上的应用存储状态 | + +- 示例 + + ```js + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStats(uuid, packageName).then(function(BundleStats){ + // do something + }); + ``` + +## storagestatistics.getBundleStats + +getBundleStats(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷上的应用存储状态，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ----------------------------------------------------- | ---- | ------------------------------------ | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\<[Bundlestats](#bundlestats)\> | 是 | 获取指定卷上的应用存储状态之后的回调 | + +- 示例 + + ```js + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStats(uuid, packageName, function(error, BundleStats){ + // do something + }); + ``` + +## BundleStats + +### 属性 + +| 名称 | 类型 | 说明 | +| --------- | ------ | -------------- | +| appSize | number | app数据大小 | +| cacheSize | number | 缓存数据大小 | +| dataSize | number | 应用总数据大小 | \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md new file mode 100644 index 0000000000..50110ee37d --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -0,0 +1,167 @@ +# 卷管理 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本 + +## 导入模块 + +```js +import volumemanager from "@ohos.volumemanager"; +``` + +## 系统能力 + +SystemCapability.FileManagement.StorageService.Volume + +## volumemanager.getAllVolumes + +getAllVolumes(): Promise\ + +异步获取当前所有可获得的卷信息，以promise方式返回。 + +- 返回值 + + | 类型 | 说明 | + | ------------------------------ | -------------------------- | + | Promise\<[Volume](#volume)[]\> | 返回当前所有可获得的卷信息 | + +- 示例 + + ```js + volumemanager.getAllVolumes().then(function(volumes){ + // do something + }); + ``` + +## volumemanager.getAllVolumes + +getAllVolumes(callback:AsyncCallback\):void + +异步获取当前所有可获得的卷信息，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------------- | ---- | ------------------------------------ | + | callback | callback:AsyncCallback\<[Volume](#volume)[]\> | 是 | 获取当前所有可获得的卷信息之后的回调 | + +- 示例 + + ```js + let uuid = ""; + volumemanager.getAllVolumes(uuid, function(error, volumes){ + // do something + }); + ``` + + +## volumemanager.mount + +mount(volumeId: string): Promise\ + +异步挂载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 挂载指定卷 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.mount(volumeId).then(function(flag){ + // do something + }); + ``` + +## volumemanager.mount + +mount(volumeId: string, callback:AsyncCallback\):void + +异步获取指定卷的可用空间大小，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------- | ---- | -------------------- | + | volumeId | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 挂载指定卷之后的回调 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.mount(volumeId, function(error, flag){ + // do something + }); + ``` + +## volumemanager.unmount + +unmount(volumeId: string): Promise\ + +异步卸载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 卸载指定卷 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.unmount(volumeId).then(function(flag){ + // do something + }); + ``` + +## volumemanager.unmount + +unmount(volumeId: string, callback:AsyncCallback\):void + +异步卸载指定卷，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------- | ---- | -------------------- | + | volumeId | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 卸载指定卷之后的回调 | + +- 示例 + + ```js + let volumeId = ""; + volumemanager.unmount(volumeId, function(error, flag){ + // do something + }); + ``` + +## Volume + +### 属性 + +| 名称 | 类型 | 说明 | +| ----------- | ------- | -------------------- | +| id | number | 卷id | +| uuid | string | 卷uuid | +| description | string | 卷相关描述 | +| removeAble | boolean | 是否为可移动存储设备 | +| state | int | 当前卷状态 | +| path | string | 卷的挂载地址 | \ No newline at end of file -- GitLab