應用空間統計

該模塊提供空間查詢相關的常用功能：包括對內外卡的空間查詢，對應用分類數據統計的查詢，對應用數據的查詢等。

說明：
開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

• 本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。
• API 9當前為Canary版本，僅供試用，不保證接口可穩定調用。

導入模塊

import storageStatistics from "@ohos.storageStatistics";

storageStatistics.getTotalSizeOfVolume

getTotalSizeOfVolume(volumeUuid: string): Promise

異步獲取指定卷的總空間大小，以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):void

異步獲取指定卷的總空間大小，以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

異步獲取指定卷的可用空間大小，以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):void

異步獲取指定卷的可用空間大小，以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.getBundleStats9+

getBundleStats(packageName: string): Promise

異步獲取應用存儲數據，以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.getBundleStats9+

getBundleStats(packageName: string, callback: AsyncCallback): void

異步獲取應用存儲數據，以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.getCurrentBundleStats9+

getCurrentBundleStats(): Promise

第三方應用異步獲取占用空間，以promise方式返回。

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

返回值：

示例：

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

storageStatistics.getCurrentBundleStats9+

getCurrentBundleStats(callback: AsyncCallback): void

第三方應用異步獲取占用空間，以callback方式返回。

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

參數：

示例：

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

BundleStats9+

屬性

系統能力 ：以下各項對應的系統能力均為SystemCapability.FileManagement.StorageService.SpatialStatistics

該接口為系統接口，三方應用不支持調用

storageStatistics.getTotalSize9+

getTotalSize(): Promise

獲取內卡的總空間大小，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

返回值：

示例：

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

storageStatistics.getTotalSize9+

getTotalSize(callback: AsyncCallback): void

獲取內卡的總空間大小，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

參數：

示例：

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

storageStatistics.getFreeSize9+

getFreeSize(): Promise

獲取內卡的可用空間大小，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

返回值：

示例：

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

storageStatistics.getFreeSize9+

getFreeSize(callback: AsyncCallback): void

獲取內卡的可用空間大小，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

參數：

示例：

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

storageStatistics.getSystemSize9+

getSystemSize(): Promise

異步獲取系統空間大小，以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.getSystemSize9+

getSystemSize(callback:AsyncCallback):void

異步獲取系統空間大小，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

參數：

示例：

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

storageStatistics.getUserStorageStats9+

getUserStorageStats(userId? : number): Promise

異步獲取用戶各類別數據大小，以promise方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

參數：

返回值：

示例：

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

storageStatistics.getUserStorageStats9+

getUserStorageStats(userId: number, callback:AsyncCallback):void

異步獲取用戶各類別數據大小，以callback方式返回。

需要權限 ：ohos.permission.STORAGE_MANAGER

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

該接口為系統接口，三方應用不支持調用

參數：

示例：

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

StorageStats9+

屬性

系統能力 ：以下各項對應的系統能力均為SystemCapability.FileManagement.StorageService.SpatialStatistics

該接口為系統接口，三方應用不支持調用

審核編輯 黃宇