@ohos.file.storageStatistics (Application Storage Statistics)

The storageStatistics module provides APIs for obtaining storage space information, including the space of built-in and plug-in memory cards, space occupied by different types of data, and space of application data.

NOTE

The initial APIs of this module are supported since API version 8. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

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

storageStatistics.getTotalSizeOfVolume

getTotalSizeOfVolume(volumeUuid: string): Promise<number>

Obtains the total size (in bytes) of the specified volume in an external storage device. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the total size (in bytes) of the specified volume in an external storage device. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getFreeSizeOfVolume

getFreeSizeOfVolume(volumeUuid: string): Promise<number>

Obtains the available space (in bytes) of the specified volume in an external storage device. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the available space (in bytes) of the specified volume in an external storage device. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getBundleStats⁹⁺

getBundleStats(packageName: string): Promise<BundleStats>

Obtains the space (in bytes) of an application. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the space (in bytes) of an application. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(): Promise<BundleStats>

Obtains the space (in bytes) of this third-party application. This API uses a promise to return the result.

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void

Obtains the space (in bytes) of this third-party application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

BundleStats⁹⁺

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

storageStatistics.getTotalSize⁹⁺

getTotalSize(): Promise<number>

Obtains the total size (in bytes) of the built-in storage. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getTotalSize⁹⁺

getTotalSize(callback: AsyncCallback<number>): void

Obtains the total size (in bytes) of the built-in storage. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getFreeSize⁹⁺

getFreeSize(): Promise<number>

Obtains the available space (in bytes) of the built-in storage. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getFreeSize⁹⁺

getFreeSize(callback: AsyncCallback<number>): void

Obtains the available space (in bytes) of the built-in storage. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getSystemSize⁹⁺

getSystemSize(): Promise<number>

Obtains the system data space, in bytes. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the system data space, in bytes. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(): Promise<StorageStats>

Obtains the storage statistics (in bytes) of this user. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the storage statistics (in bytes) of this user. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

storageStatistics.getUserStorageStats⁹⁺

getUserStorageStats(userId: number): Promise<StorageStats>

Obtains the storage statistics (in bytes) of the specified user. This API uses a promise to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Return value

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

Obtains the storage statistics (in bytes) of the specified user. This API uses an asynchronous callback to return the result.

Required permissions: ohos.permission.STORAGE_MANAGER

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.

Parameters

Error codes

For details about the error codes, see File Management Error Codes.

Example

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

StorageStats⁹⁺

System capability: SystemCapability.FileManagement.StorageService.SpatialStatistics

System API: This is a system API.