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

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

说明：

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

导入模块

import  { storageStatistics } from '@kit.CoreFileKit';

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(): Promise<BundleStats>

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

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

返回值：

错误码：

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

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  storageStatistics.getCurrentBundleStats().then((BundleStats: storageStatistics.BundleStats) => {
    console.info("getCurrentBundleStats successfully:" + JSON.stringify(BundleStats));
  }).catch((err: BusinessError) => {
    console.error("getCurrentBundleStats failed with error:"+ JSON.stringify(err));
  });

storageStatistics.getCurrentBundleStats⁹⁺

getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void

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

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

参数：

错误码：

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

示例：

  import { BusinessError } from '@kit.BasicServicesKit';
  storageStatistics.getCurrentBundleStats((error: BusinessError, bundleStats: storageStatistics.BundleStats) => {
    if (error) {
      console.error("getCurrentBundleStats failed with error:" + JSON.stringify(error));
    } else {
      // do something
      console.info("getCurrentBundleStats successfully:" + JSON.stringify(bundleStats));
    }
  });

storageStatistics.getTotalSize¹⁵⁺

getTotalSize(): Promise<number>

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

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

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
storageStatistics.getTotalSize().then((number: number) => {
  console.info("getTotalSize successfully:" + JSON.stringify(number));
}).catch((err: BusinessError) => {
  console.error("getTotalSize failed with error:"+ JSON.stringify(err));
});

storageStatistics.getTotalSize¹⁵⁺

getTotalSize(callback: AsyncCallback<number>): void

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

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

参数：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
storageStatistics.getTotalSize((error: BusinessError, number: number) => {
  if (error) {
    console.error("getTotalSize failed with error:" + JSON.stringify(error));
  } else {
    // do something
    console.info("getTotalSize successfully:" + number);
  }
});

storageStatistics.getTotalSizeSync¹⁵⁺

getTotalSizeSync(): number

同步获取内置存储的总空间大小（单位为Byte）。

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

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
try {
  let number = storageStatistics.getTotalSizeSync();
  console.info("getTotalSizeSync successfully:" + JSON.stringify(number));
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error("getTotalSizeSync failed with error:" + JSON.stringify(error));
}

storageStatistics.getFreeSize¹⁵⁺

getFreeSize(): Promise<number>

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

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

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
storageStatistics.getFreeSize().then((number: number) => {
  console.info("getFreeSize successfully:" + JSON.stringify(number));
}).catch((err: BusinessError) => {
  console.error("getFreeSize failed with error:" + JSON.stringify(err));
});

storageStatistics.getFreeSize¹⁵⁺

getFreeSize(callback: AsyncCallback<number>): void

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

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

参数：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
storageStatistics.getFreeSize((error: BusinessError, number: number) => {
  if (error) {
    console.error("getFreeSize failed with error:" + JSON.stringify(error));
  } else {
    // do something
    console.info("getFreeSize successfully:" + number);
  }
});

storageStatistics.getFreeSizeSync¹⁵⁺

getFreeSizeSync(): number

同步获取内置存储的可用空间大小（单位为Byte）。

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

返回值：

错误码：

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

示例：

import { BusinessError } from '@kit.BasicServicesKit';
try {
  let number = storageStatistics.getFreeSizeSync();
  console.info("getFreeSizeSync successfully:" + JSON.stringify(number));
} catch (err) {
  let error: BusinessError = err as BusinessError;
  console.error("getFreeSizeSync failed with error:" + JSON.stringify(error));
}

BundleStats⁹⁺

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

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Core File Kit（文件基础服务）

harmony 鸿蒙Environment

harmony 鸿蒙FileIO

harmony 鸿蒙FileShare_PolicyErrorResult

harmony 鸿蒙FileShare_PolicyInfo

harmony 鸿蒙error_code.h

harmony 鸿蒙文件管理错误码

harmony 鸿蒙FileShare

harmony 鸿蒙FileUri

harmony 鸿蒙@ohos.application.BackupExtensionAbility (备份恢复扩展能力)(系统接口)