diff --git a/en/application-dev/reference/apis/js-apis-storage-statistics.md b/en/application-dev/reference/apis/js-apis-storage-statistics.md index 91690344eefbab65a7023f9cb7b8561a7626d657..cf3f8347a415bde8aa969e6d9585d8d3f69dd643 100644 --- a/en/application-dev/reference/apis/js-apis-storage-statistics.md +++ b/en/application-dev/reference/apis/js-apis-storage-statistics.md @@ -1,34 +1,33 @@ # App Storage Statistics -> ![icon-note.gif](public_sys-resources/icon-note.gif) **NOTE** +> ![icon-note.gif](public_sys-resources/icon-note.gif) **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. +> - 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. +> - This is a system API and cannot be called by third-party applications. ## Modules to Import ```js -import storagestatistics from "@ohos.storagestatistics"; +import storagestatistics from "@ohos.storageStatistics"; ``` -## System Capabilities - -SystemCapability.FileManagement.StorageService.SpatialStatistics - ## storagestatistics.getTotalSizeOfVolume getTotalSizeOfVolume(volumeUuid: string): Promise<number> Asynchronously obtains the total space of the specified volume. This method uses a promise to return the result. +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics + - Parameters - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory| Description| | ---------- | ------ | ---- | ---- | - | volumeUuid | string | Yes| Universally unique identifier (UUID) of the volume.| + | volumeUuid | string | Yes | UUID of the volume.| - Return value - | Type| Description| + | Type | Description | | --------------------- | ---------------- | | Promise<number> | Promise used to return the total space of the volume.| @@ -49,12 +48,14 @@ getTotalSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):v Asynchronously obtains the total space of the specified volume. This method uses a callback to return the result. +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics + - Parameters - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory| Description | | ---------- | ------------------------------------ | ---- | -------------------------- | - | volumeUuid | string | Yes| UUID of the volume.| - | callback | callback:AsyncCallback<number> | Yes| Callback invoked to return the total space of the volume.| + | volumeUuid | string | Yes | UUID of the volume. | + | callback | callback:AsyncCallback<number> | Yes | Callback invoked to return the total space of the volume.| - Example @@ -62,9 +63,10 @@ Asynchronously obtains the total space of the specified volume. This method uses let uuid = ""; storagestatistics.getTotalSizeOfVolume(uuid, function(error, number){ // Do something + console.info("getTotalSizeOfVolume successfully:"+ number); }); ``` - + ## storagestatistics.getFreeSizeOfVolume @@ -73,15 +75,17 @@ getFreeSizeOfVolume(volumeUuid: string): Promise<number> Asynchronously obtains the available space of the specified volume. This method uses a promise to return the result. +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics + - Parameters - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory| Description| | ---------- | ------ | ---- | ---- | - | volumeUuid | string | Yes| UUID of the volume.| + | volumeUuid | string | Yes | UUID of the volume.| - Return value - | Type| Description| + | Type | Description | | --------------------- | ------------------ | | Promise<number> | Promise used to return the available space of the volume.| @@ -103,12 +107,14 @@ getFreeSizeOfVolume(volumeUuid: string, callback:AsyncCallback<number>):vo Asynchronously obtains the available space of the specified volume. This method uses a callback to return the result. +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics + - Parameters - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory| Description | | ---------- | ------------------------------------ | ---- | ---------------------------- | - | volumeUuid | string | Yes| UUID of the volume.| - | callback | callback:AsyncCallback<number> | Yes| Callback invoked to return the available space of the volume.| + | volumeUuid | string | Yes | UUID of the volume. | + | callback | callback:AsyncCallback<number> | Yes | Callback invoked to return the available space of the volume.| - Example @@ -116,34 +122,35 @@ Asynchronously obtains the available space of the specified volume. This method let uuid = ""; storagestatistics.getFreeSizeOfVolume(uuid, function(error, number){ // Do something + console.info("getFreeSizeOfVolume successfully:"+ number); }); ``` ## storagestatistics.getBundleStats -getBundleStats(volumeUuid: string, packageName:String, ): Promise<BundleStats> +getBundleStats(packageName: string): Promise<BundleStats> -Asynchronously obtains the bundle status on the specified volume. This method uses a promise to return the result. +Obtains the bundle status. This method uses a promise to return the result. + +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics - Parameters - | Name| Type| Mandatory| Description| + | Name | Type | Mandatory| Description | | ----------- | ------ | ---- | -------- | - | volumeUuid | string | Yes| UUID of the volume.| - | packageName | string | Yes| Bundle name of the app.| - + | packageName | string | Yes | Bundle name of the app.| + - Return value - | Type| Description| + | Type | Description | | ------------------------------------------ | -------------------------- | | Promise<[Bundlestats](#bundlestats)> | Promise used to return the bundle status on the volume.| - Example ```js - let uuid = ""; let packageName = ""; - storagestatistics.getBundleStats(uuid, packageName).then(function(BundleStats){ + storagestatistics.getBundleStats(packageName).then(function(BundleStats){ console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats)); }).catch(function(err){ console.info("getBundleStats failed with error:"+ err); @@ -152,33 +159,37 @@ Asynchronously obtains the bundle status on the specified volume. This method us ## storagestatistics.getBundleStats -getBundleStats(volumeUuid: string, callback:AsyncCallback<BundleStats>):void +getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>): void -Asynchronously obtains the bundle status on the specified volume. This method uses a callback to return the result. +Obtains the bundle status. This method uses an asynchronous callback to return the result. -- Parameters +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics - | Name| Type| Mandatory| Description| - | ---------- | --------------------------------------------------------- | ---- | ------------------------------------ | - | volumeUuid | string | Yes| UUID of the volume.| - | callback | callback:AsyncCallback<[Bundlestats](#bundlestats)> | Yes| Callback invoked to return the bundle status on the volume.| +- Parameters + | Name | Type | Mandatory| Description | + | -------- | --------------------------------------------------------- | ---- | ------------------------------------ | + | packageName | string | Yes | Bundle name of the app.| + | callback | callback:AsyncCallback<[Bundlestats](#bundlestats)> | Yes | Callback invoked to return the bundle status on the volume.| + - Example ```js - let uuid = ""; let packageName = ""; - storagestatistics.getBundleStats(uuid, packageName, function(error, BundleStats){ + storagestatistics.getBundleStats(packageName, function(error, BundleStats){ // Do something + console.info("getBundleStats successfully:"+ JSON.stringify(BundleStats)); }); ``` -## BundleStats +## BundleStats9+ + +**System capability**: SystemCapability.FileManagement.StorageService.SpatialStatistics ### Attributes -| Name| Type| Description| +| Name | Type | Description | | --------- | ------ | -------------- | -| appSize | number | Size of the app.| -| cacheSize | number | Size of the cached data.| -| dataSize | number | Total data size of the app.| +| appSize9+ | number | Size of the app. | +| cacheSize9+ | number | Size of the cached data. | +| dataSize9+ | number | Total data size of the app.|