From 87e9f31e0c1cf6a9818a6042c14a13354c657be0 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 27 Jan 2022 11:04:00 +0800 Subject: [PATCH 1/3] add storagestatistics apis Signed-off-by: zhangxingxia --- .../reference/apis/Readme-CN.md | 2 + .../reference/apis/js-apis-environment.md | 6 +- .../apis/js-apis-storage-statistics.md | 175 ++++++++++++++++++ .../reference/apis/js-apis-volumemanager.md | 166 +++++++++++++++++ 4 files changed, 345 insertions(+), 4 deletions(-) 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 5834381fe4f..2cf0580b633 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -31,6 +31,8 @@ - [文件管理](js-apis-fileio.md) - [Statfs](js-apis-statfs.md) - [目录环境](js-apis-environment.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-environment.md b/zh-cn/application-dev/reference/apis/js-apis-environment.md index aeab8cf8d8b..bec35418b82 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-environment.md +++ b/zh-cn/application-dev/reference/apis/js-apis-environment.md @@ -8,8 +8,6 @@ import environment from '@ohos.environment'; ``` - - ## 权限列表 无 @@ -56,7 +54,7 @@ getStorageDataDir(callback:AsyncCallback<string>):void }); ``` -## getUserDataDir +## environment.getUserDataDir getUserDataDir():Promise<string> @@ -78,7 +76,7 @@ getUserDataDir():Promise<string> }); ``` -## getUserDataDir +## environment.getUserDataDir getUserDataDir(callback:AsyncCallback<string>): void 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 00000000000..192fa032b21 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md @@ -0,0 +1,175 @@ +# 应用空间统计 + + + +## 导入模块 + +``` +import storagestatistics from "@ohos.storagestatistics"; +``` + +## 权限列表 + +无 + +## storagestatistics.getTotalSizeOfVolume + +getTotalSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的总空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ---------------- | + | Promise\ | 返回指定卷总空间 | + +- 示例 + + ``` + 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\ | 是 | 获取指定卷总空间之后的回调 | + +- 示例 + + ``` + let uuid = ""; + storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + + + +## storagestatistics.getFreeSizeOfVolume + +getFreeSizeOfVolume(volumeUuid: string): Promise\ + +异步获取指定卷的可用空间大小，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------ | ---- | ---- | + | volumeUuid | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ----------------- | ------------------ | + | Promise\ | 返回指定卷可用空间 | + +- 示例 + + ``` + 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\ | 是 | 获取指定卷可用空间之后的回调 | + +- 示例 + + ``` + let uuid = ""; + storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ + // do something + }); + ``` + +## storagestatistics.getBundleStat + +getBundleStat(volumeUuid: string, packageName:String, ): Promise\ + +异步获取指定卷上的应用存储状态，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ----------- | ------ | ---- | -------- | + | volumeUuid | string | 是 | 卷id | + | packageName | string | 是 | 应用包名 | + +- 返回值 + + | 类型 | 说明 | + | ---------------------- | -------------------------- | + | Promise\ | 返回指定卷上的应用存储状态 | + +- 示例 + + ``` + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStat(uuid, packageName).then(function(BundleStats){ + // do something + }); + ``` + +## storagestatistics.getBundleStat + +getBundleStat(volumeUuid: string, callback:AsyncCallback\):void + +异步获取指定卷上的应用存储状态，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ------------------------------------- | ---- | ------------------------------------ | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\ | 是 | 获取指定卷上的应用存储状态之后的回调 | + +- 示例 + + ``` + let uuid = ""; + let packageName = ""; + storagestatistics.getBundleStat(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 00000000000..fdf4ed24f13 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -0,0 +1,166 @@ +# 卷管理 + + + +## 导入模块 + +``` +import volumemanager from "@ohos.volumemanager"; +``` + +## 权限列表 + +无 + +## volumemanager.getAllVolumes + +getAllVolumes(): Promise\ + +异步获取当前所有可获得的卷信息，以promise方式返回。 + +- 返回值 + + | 类型 | 说明 | + | ------------------- | -------------------------- | + | Promise\ | 返回当前所有可获得的卷信息 | + +- 示例 + + ``` + volumemanager.getAllVolumes().then(function(volumes){ + // do something + }); + ``` + +## volumemanager.getAllVolumes + +getAllVolumes(callback:AsyncCallback\):void + +异步获取当前所有可获得的卷信息，以callback方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ---------------------------------- | ---- | ------------------------------------ | + | callback | callback:AsyncCallback\ | 是 | 获取当前所有可获得的卷信息之后的回调 | + +- 示例 + + ``` + let uuid = ""; + volumemanager.getAllVolumes(uuid, function(error, volumes){ + // do something + }); + ``` + + +## volumemanager.mount + +mount(volumeId: string): Promise\ + +异步挂载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 挂载指定卷 | + +- 示例 + + ``` + 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\ | 是 | 挂载指定卷之后的回调 | + +- 示例 + + ``` + let volumeId = ""; + volumemanager.mount(volumeId, function(error, flag){ + // do something + }); + ``` + +## volumemanager.unmount + +unmount(volumeId: string): Promise\ + +异步卸载指定卷，以promise方式返回。 + +- 参数 + + | 参数名 | 类型 | 必填 | 说明 | + | -------- | ------ | ---- | ---- | + | volumeId | string | 是 | 卷id | + +- 返回值 + + | 类型 | 说明 | + | ------------------ | ---------- | + | Promise\ | 卸载指定卷 | + +- 示例 + + ``` + 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\ | 是 | 卸载指定卷之后的回调 | + +- 示例 + + ``` + 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 -- Gitee From 7dd55c81559ab322463a0b09e802db8fee9ce019 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 10 Feb 2022 15:38:01 +0800 Subject: [PATCH 2/3] update apis Signed-off-by: zhangxingxia --- .../apis/js-apis-storage-statistics.md | 32 ++++++++----------- 1 file changed, 14 insertions(+), 18 deletions(-) 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 index 192fa032b21..1436387290d 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md +++ b/zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md @@ -4,14 +4,10 @@ ## 导入模块 -``` +```js import storagestatistics from "@ohos.storagestatistics"; ``` -## 权限列表 - -无 - ## storagestatistics.getTotalSizeOfVolume getTotalSizeOfVolume(volumeUuid: string): Promise\ @@ -32,7 +28,7 @@ getTotalSizeOfVolume(volumeUuid: string): Promise\ - 示例 - ``` + ```js let uuid = ""; storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){ // do something @@ -54,7 +50,7 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void - 示例 - ``` + ```js let uuid = ""; storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ // do something @@ -83,7 +79,7 @@ getFreeSizeOfVolume(volumeUuid: string): Promise\ - 示例 - ``` + ```js let uuid = ""; storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){ // do something @@ -105,7 +101,7 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback\):void - 示例 - ``` + ```js let uuid = ""; storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ // do something @@ -127,13 +123,13 @@ getBundleStat(volumeUuid: string, packageName:String, ): Promise\ - 返回值 - | 类型 | 说明 | - | ---------------------- | -------------------------- | - | Promise\ | 返回指定卷上的应用存储状态 | + | 类型 | 说明 | + | ------------------------------------------ | -------------------------- | + | Promise<[Bundlestats](#bundlestats)> | 返回指定卷上的应用存储状态 | - 示例 - ``` + ```js let uuid = ""; let packageName = ""; storagestatistics.getBundleStat(uuid, packageName).then(function(BundleStats){ @@ -149,14 +145,14 @@ getBundleStat(volumeUuid: string, callback:AsyncCallback\):void - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | ---------- | ------------------------------------- | ---- | ------------------------------------ | - | volumeUuid | string | 是 | 卷id | - | callback | callback:AsyncCallback\ | 是 | 获取指定卷上的应用存储状态之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | ---------- | ----------------------------------------------------- | ---- | ------------------------------------ | + | volumeUuid | string | 是 | 卷id | + | callback | callback:AsyncCallback\<[Bundlestats](#bundlestats)\> | 是 | 获取指定卷上的应用存储状态之后的回调 | - 示例 - ``` + ```js let uuid = ""; let packageName = ""; storagestatistics.getBundleStat(uuid, packageName, function(error, BundleStats){ -- Gitee From 5e37c27d889f5b902dda51f470881f718ad85976 Mon Sep 17 00:00:00 2001 From: zhangxingxia Date: Thu, 10 Feb 2022 15:59:28 +0800 Subject: [PATCH 3/3] update apis Signed-off-by: zhangxingxia --- .../reference/apis/js-apis-volumemanager.md | 26 +++++++++---------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md index fdf4ed24f13..268863309ee 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md +++ b/zh-cn/application-dev/reference/apis/js-apis-volumemanager.md @@ -4,7 +4,7 @@ ## 导入模块 -``` +```js import volumemanager from "@ohos.volumemanager"; ``` @@ -20,13 +20,13 @@ getAllVolumes(): Promise\ - 返回值 - | 类型 | 说明 | - | ------------------- | -------------------------- | - | Promise\ | 返回当前所有可获得的卷信息 | + | 类型 | 说明 | + | ------------------------------ | -------------------------- | + | Promise\<[Volume](#volume)[]\> | 返回当前所有可获得的卷信息 | - 示例 - ``` + ```js volumemanager.getAllVolumes().then(function(volumes){ // do something }); @@ -40,13 +40,13 @@ getAllVolumes(callback:AsyncCallback\):void - 参数 - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ------------------------------------ | - | callback | callback:AsyncCallback\ | 是 | 获取当前所有可获得的卷信息之后的回调 | + | 参数名 | 类型 | 必填 | 说明 | + | -------- | --------------------------------------------- | ---- | ------------------------------------ | + | callback | callback:AsyncCallback\<[Volume](#volume)[]\> | 是 | 获取当前所有可获得的卷信息之后的回调 | - 示例 - ``` + ```js let uuid = ""; volumemanager.getAllVolumes(uuid, function(error, volumes){ // do something @@ -74,7 +74,7 @@ mount(volumeId: string): Promise\ - 示例 - ``` + ```js let volumeId = ""; volumemanager.mount(volumeId).then(function(flag){ // do something @@ -96,7 +96,7 @@ mount(volumeId: string, callback:AsyncCallback\):void - 示例 - ``` + ```js let volumeId = ""; volumemanager.mount(volumeId, function(error, flag){ // do something @@ -123,7 +123,7 @@ unmount(volumeId: string): Promise\ - 示例 - ``` + ```js let volumeId = ""; volumemanager.unmount(volumeId).then(function(flag){ // do something @@ -145,7 +145,7 @@ unmount(volumeId: string, callback:AsyncCallback\):void - 示例 - ``` + ```js let volumeId = ""; volumemanager.unmount(volumeId, function(error, flag){ // do something -- Gitee