@ohos.file.storageStatistics (应用空间统计)

该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。

说明：

本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import storageStatistics from "@ohos.file.storageStatistics";

storageStatistics.getTotalSizeOfVolume

getTotalSizeOfVolume(volumeUuid: string): Promise<number>

异步获取外置存储设备中指定卷设备的总空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

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

异步获取外置存储设备中指定卷设备的总空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let uuid = "";
storageStatistics.getTotalSizeOfVolume(uuid, function(error, number){
    // do something
    console.info("getTotalSizeOfVolume successfully:"+ number);
});

storageStatistics.getFreeSizeOfVolume

getFreeSizeOfVolume(volumeUuid: string): Promise<number>

异步获取外置存储设备中指定卷设备的可用空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

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

异步获取外置存储设备中指定卷设备的可用空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let uuid = "";
storageStatistics.getFreeSizeOfVolume(uuid, function(error, number){
    // do something
    console.info("getFreeSizeOfVolume successfully:"+ number);
});

storageStatistics.getBundleStats⁹⁺

getBundleStats(packageName: string): Promise<BundleStats>

异步获取应用存储空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

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⁹⁺

getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>): void

异步获取应用存储空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let packageName = "";
storageStatistics.getBundleStats(packageName, function(error, BundleStats){
    // do something
    console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats));
});

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(): Promise<BundleStats>

第三方应用异步获取当前应用存储空间大小（单位为Byte），以promise方式返回。

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let bundleStats = storageStatistics.getCurrentBundleStats();
console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void

第三方应用异步获取当前应用存储空间大小（单位为Byte），以callback方式返回。

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getCurrentBundleStats(function(error, bundleStats){
    // do something
    console.info("getCurrentBundleStats successfully:"+ JSON.stringify(bundleStats));
});

BundleStats⁹⁺

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

storageStatistics.getTotalSize⁹⁺

getTotalSize(): Promise<number>

获取内置存储的总空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let number = storageStatistics.getTotalSize();
console.info("getTotalSize successfully:"+ JSON.stringify(number));

storageStatistics.getTotalSize⁹⁺

getTotalSize(callback: AsyncCallback<number>): void

获取内置存储的总空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getTotalSize(function(error, number){
    // do something
    console.info("getTotalSize successfully:"+ JSON.stringify(number));
});

storageStatistics.getFreeSize⁹⁺

getFreeSize(): Promise<number>

获取内置存储的可用空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let number = storageStatistics.getFreeSize();
console.info("getFreeSize successfully:"+ JSON.stringify(number));

storageStatistics.getFreeSize⁹⁺

getFreeSize(callback: AsyncCallback<number>): void

获取内置存储的可用空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getFreeSize(function(error, number){
    // do something
    console.info("getFreeSize successfully:"+ JSON.stringify(number));
});

storageStatistics.getSystemSize⁹⁺

getSystemSize(): Promise<number>

异步获取系统数据的空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getSystemSize().then(function(number){
    console.info("getSystemSize successfully:"+ number);
}).catch(function(err){
    console.info("getSystemSize failed with error:"+ err);
});

storageStatistics.getSystemSize⁹⁺

getSystemSize(callback: AsyncCallback<number>): void

异步获取系统数据的空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getSystemSize(function(error, number){
    // do something
    console.info("getSystemSize successfully:"+ number);
});

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(): Promise<StorageStats>

异步获取当前用户各类别存储空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getUserStorageStats().then(function(StorageStats){
    console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}).catch(function(err){
    console.info("getUserStorageStats failed with error:"+ err);
});

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(callback: AsyncCallback<StorageStats>): void

异步获取当前用户各类别存储空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

storageStatistics.getUserStorageStats(function(error, StorageStats){
    // do something
    console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(userId: number): Promise<StorageStats>

异步获取指定用户各类别存储空间大小（单位为Byte），以promise方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

返回值：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let userId = 100;
storageStatistics.getUserStorageStats(userId).then(function(StorageStats){
    console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}).catch(function(err){
    console.info("getUserStorageStats failed with error:"+ err);
});

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(userId: number, callback: AsyncCallback<StorageStats>): void

异步获取指定用户各类别存储空间大小（单位为Byte），以callback方式返回。

需要权限：ohos.permission.STORAGE_MANAGER

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。

参数：

错误码：

以下错误码的详细介绍请参见文件管理错误码。

示例：

let userId = 100;
storageStatistics.getUserStorageStats(userId, function(error, StorageStats){
    // do something
    console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});

StorageStats⁹⁺

系统能力：SystemCapability.FileManagement.StorageService.SpatialStatistics

系统接口： 该接口为系统接口。