应用空间统计
说明:
- 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
- API 9当前为Canary版本,仅供试用,不保证接口可稳定调用。
- 本模块接口为系统接口,三方应用不支持调用。
该模块提供空间查询相关的常用功能:包括对内外卡的空间查询,对应用分类数据统计的查询,对应用数据的查询等。
导入模块
import storagestatistics from "@ohos.storageStatistics";
storagestatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string): Promise<number>
异步获取指定卷的总空间大小,以promise方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeUuid | string | 是 | 卷id |
- 返回值
类型 | 说明 |
---|---|
Promise<number> | 返回指定卷总空间 |
-
示例
let uuid = ""; storagestatistics.getTotalSizeOfVolume(uuid).then(function(number){ console.info("getTotalSizeOfVolume successfully:"+ number); }).catch(function(err){ console.info("getTotalSizeOfVolume failed with error:"+ err); });
storagestatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):void
异步获取指定卷的总空间大小,以callback方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeUuid | string | 是 | 卷id |
callback | callback:AsyncCallback<number> | 是 | 获取指定卷总空间之后的回调 |
-
示例
let uuid = ""; storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ // do something console.info("getTotalSizeOfVolume successfully:"+ number); });
storagestatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string): Promise<number>
异步获取指定卷的可用空间大小,以promise方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeUuid | string | 是 | 卷id |
- 返回值
类型 | 说明 |
---|---|
Promise<number> | 返回指定卷可用空间 |
-
示例
let uuid = ""; storagestatistics.getFreeSizeOfVolume(uuid).then(function(number){ console.info("getFreeSizeOfVolume successfully:"+ number); }).catch(function(err){ console.info("getFreeSizeOfVolume failed with error:"+ err); });
storagestatistics.getFreeSizeOfVolume
getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):void
异步获取指定卷的可用空间大小,以callback方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
volumeUuid | string | 是 | 卷id |
callback | callback:AsyncCallback<number> | 是 | 获取指定卷可用空间之后的回调 |
-
示例
let uuid = ""; storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ // do something console.info("getFreeSizeOfVolume successfully:"+ number); });
storagestatistics.getBundleStats9+
getBundleStats(packageName: string): Promise<BundleStats>
异步获取应用存储数据,以promise方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
packageName | string | 是 | 应用包名 |
- 返回值
类型 | 说明 |
---|---|
Promise<Bundlestats> | 返回指定卷上的应用存储数据 |
-
示例
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.getBundleStats9+
getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>): void
异步获取应用存储数据,以callback方式返回。
系统能力:SystemCapability.FileManagement.StorageService.SpatialStatistics
- 参数
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
packageName | string | 是 | 应用包名 |
callback | callback:AsyncCallback<Bundlestats> | 是 | 获取指定卷上的应用存储数据之后的回调 |
-
示例
let packageName = ""; storagestatistics.getBundleStats(packageName, function(error, BundleStats){ // do something console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats)); });
BundleStats9+
系统能力:以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics。
属性
名称 | 类型 | 说明 |
---|---|---|
appSize9+ | number | app数据大小 |
cacheSize9+ | number | 缓存数据大小 |
dataSize9+ | number | 应用总数据大小 |