Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 4f52dcad 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!14124 storage service接口文件名以及错误码整改 

Merge pull request !14124 from 张文迪/errcode
上级 1710a359 4683263e
隐藏空白更改
内联 并排
Showing with 136 addition and 80 deletion
zh-cn/application-dev/reference/apis/js-apis-storage-statistics.md → zh-cn/application-dev/reference/apis/js-apis-file-storage-statistics.md
浏览文件 @ 4f52dcad
# @ohos.storageStatistics (应用空间统计)
# @ohos.file.storageStatistics (应用空间统计)
该模块提供空间查询相关的常用功能：包括对内外卡的空间查询，对应用分类数据统计的查询，对应用数据的查询等。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
```js
import storageStatistics from "@ohos.storageStatistics";
import storageStatistics from "@ohos.file.storageStatistics";
```
## storageStatistics.getTotalSizeOfVolume
getTotalSizeOfVolume(volumeUuid: string): Promise<number>
异步获取指定卷的总空间大小，以promise方式返回。
异步获取外置存储设备中指定卷设备的总空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| volumeUuid | string | 是 | 卷id |
| volumeUuid | string | 是 | 卷设备uuid |
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise<number> | 返回指定卷总空间 |
| Promise<number> | 返回指定卷设备的总空间大小（单位为Byte） |
**示例：**
......@@ -53,22 +53,22 @@ getTotalSizeOfVolume(volumeUuid: string): Promise<number>
getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>): void
异步获取指定卷的总空间大小，以callback方式返回。
异步获取外置存储设备中指定卷设备的总空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| volumeUuid | string | 是 | 卷id |
| callback | AsyncCallback<number> | 是 | 获取指定卷总空间之后的回调 |
| volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback<number> | 是 | 获取指定卷设备总空间之后的回调 |
**示例：**
......@@ -84,27 +84,27 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>):
getFreeSizeOfVolume(volumeUuid: string): Promise<number>
异步获取指定卷的可用空间大小，以promise方式返回。
异步获取外置存储设备中指定卷设备的可用空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| volumeUuid | string | 是 | 卷id |
| volumeUuid | string | 是 | 卷设备uuid |
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise<number> | 返回指定卷可用空间 |
| Promise<number> | 返回指定卷的可用空间大小（单位为Byte） |
**示例：**
......@@ -122,21 +122,21 @@ getFreeSizeOfVolume(volumeUuid: string): Promise<number>
getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>): void
异步获取指定卷的可用空间大小，以callback方式返回。
异步获取外置存储设备中指定卷设备的可用空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | ---------------------------- |
| volumeUuid | string | 是 | 卷id |
| volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback<number> | 是 | 获取指定卷可用空间之后的回调 |
**示例：**
......@@ -153,14 +153,14 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback<number>):
getBundleStats(packageName: string): Promise<BundleStats>
异步获取应用存储数据，以promise方式返回。
异步获取应用存储空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
......@@ -173,7 +173,7 @@ getBundleStats(packageName: string): Promise<BundleStats>
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise<[Bundlestats](#bundlestats9)> | 返回指定卷上的应用存储数据 |
| Promise<[Bundlestats](#bundlestats9)> | 返回指定卷上的应用存储数据（单位为Byte） |
**示例：**
......@@ -190,14 +190,14 @@ getBundleStats(packageName: string): Promise<BundleStats>
getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>): void
异步获取应用存储数据，以callback方式返回。
异步获取应用存储空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
......@@ -221,7 +221,7 @@ getBundleStats(packageName: string, callback: AsyncCallback<BundleStats>)
getCurrentBundleStats(): Promise<BundleStats>
第三方应用异步获取占用空间，以promise方式返回。
第三方应用异步获取当前应用存储空间大小（单位为Byte），以promise方式返回。
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
......@@ -229,7 +229,7 @@ getCurrentBundleStats(): Promise<BundleStats>
| 类型 | 说明 |
| ------------------------------------------ | -------------------------- |
| Promise<[Bundlestats](#bundlestats9)> | 返回指定卷上的应用存储状态 |
| Promise<[Bundlestats](#bundlestats9)> | 返回指定卷上的应用存空间大小（单位为Byte） |
**示例：**
......@@ -242,7 +242,7 @@ getCurrentBundleStats(): Promise<BundleStats>
getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void
第三方应用异步获取占用空间，以callback方式返回。
第三方应用异步获取当前应用存储空间大小（单位为Byte），以callback方式返回。
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
......@@ -250,7 +250,7 @@ getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback<[BundleStats](#bundlestats9)> | 是 | 获取指定卷上的应用存储状态之后的回调 |
| callback | AsyncCallback<[BundleStats](#bundlestats9)> | 是 | 获取指定卷上的应用存储空间大小之后的回调 |
**示例：**
......@@ -268,34 +268,33 @@ getCurrentBundleStats(callback: AsyncCallback<BundleStats>): void
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | --- | ---- | -------------- |
| appSize | number | 是 | 否 | app数据大小 |
| cacheSize | number | 是 | 否 | 缓存数据大小 |
| dataSize | number | 是 | 否 | 应用总数据大小 |
| appSize | number | 是 | 否 | app数据大小（单位为Byte） |
| cacheSize | number | 是 | 否 | 缓存数据大小（单位为Byte） |
| dataSize | number | 是 | 否 | 应用总数据大小（单位为Byte） |
## storageStatistics.getTotalSize<sup>9+</sup>
getTotalSize(): Promise&lt;number&gt;
获取内卡的总空间大小，以promise方式返回。
获取内置存储的总空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的总空间大小 |
| Promise&lt;number&gt; | 返回内置存储的总空间大小（单位为Byte） |
**示例：**
......@@ -308,21 +307,21 @@ getTotalSize(): Promise&lt;number&gt;
getTotalSize(callback: AsyncCallback&lt;number&gt;): void
获取内卡的总空间大小，以callback方式返回。
获取内置存储的总空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内卡的总空间大小之后的回调 |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的总空间大小之后的回调 |
**示例：**
......@@ -338,21 +337,21 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
getFreeSize(): Promise&lt;number&gt;
获取内卡的可用空间大小，以promise方式返回。
获取内置存储的可用空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**返回值：**
| 类型 | 说明 |
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内卡的可用空间大小 |
| Promise&lt;number&gt; | 返回内置存储的可用空间大小（单位为Byte） |
**示例：**
......@@ -366,21 +365,21 @@ getFreeSize(): Promise&lt;number&gt;
getFreeSize(callback: AsyncCallback&lt;number&gt;): void
获取内卡的可用空间大小，以callback方式返回。
获取内置存储的可用空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------ | ---- | ------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内卡的可用空间大小之后的回调 |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的可用空间大小之后的回调 |
**示例：**
......@@ -395,21 +394,21 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void
getSystemSize(): Promise&lt;number&gt;
异步获取系统空间大小，以promise方式返回。
异步获取系统数据的空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统空间大小 |
| Promise&lt;number&gt; | 返回系统数据的空间大小（单位为Byte） |
**示例：**
......@@ -425,21 +424,21 @@ getSystemSize(): Promise&lt;number&gt;
getSystemSize(callback: AsyncCallback&lt;number&gt;): void
异步获取系统空间大小，以callback方式返回。
异步获取系统数据的空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取系统空间大小之后的回调 |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取系统数据的空间大小之后的回调 |
**示例：**
......@@ -452,34 +451,90 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void
## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: number): Promise&lt;StorageStats&gt;
getUserStorageStats(): Promise&lt;StorageStats&gt;
异步获取当前用户各类别存储空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口。
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回当前用户各类别存储空间大小（单位为Byte） |
**示例：**
```js
storageStatistics.getUserStorageStats().then(function(StorageStats){
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}).catch(function(err){
console.info("getUserStorageStats failed with error:"+ err);
});
```
## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void
异步获取当前用户各类别存储空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回用户各类别存储空间大小之后的回调 |
**示例：**
```js
storageStatistics.getUserStorageStats(function(error, StorageStats){
// do something
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});
```
getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
异步获取用户各类别数据大小，以promise方式返回。
异步获取指定用户各类别存储空间大小（单位为Byte），以promise方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------ | ---- | ---- |
| userId | number | 否 | 用户id <br/>确认当前用户：<br/>-&nbsp;有值：表示指定用户。<br/>-&nbsp;无值：表示当前用户。|
| userId | number | 是 | 用户id|
**返回值：**
| 类型 | 说明 |
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回各类别数据大小 |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回指定用户各类别存储空间大小（单位为Byte） |
**示例：**
```js
let userId = 1;
let userId = 100;
storageStatistics.getUserStorageStats(userId).then(function(StorageStats){
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}).catch(function(err){
......@@ -489,29 +544,29 @@ getUserStorageStats(userId?: number): Promise&lt;StorageStats&gt;
## storageStatistics.getUserStorageStats<sup>9+</sup>
getUserStorageStats(userId?: number, callback: AsyncCallback&lt;StorageStats&gt;): void
getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;): void
异步获取用户各类别数据大小，以callback方式返回。
异步获取指定用户各类别存储空间大小（单位为Byte），以callback方式返回。
**需要权限**：ohos.permission.STORAGE_MANAGER
**系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ---------- | ------------------------------------ | ---- | -------------------------- |
| userId | number | 否 | 用户id <br/>确认当前用户：<br/>-&nbsp;有值：表示指定用户。<br/>-&nbsp;无值：表示当前用户。 |
| userId | number | 是 | 用户id |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回各类别数据大小之后的回调 |
**示例：**
```js
let userId = 1;
let userId = 100;
storageStatistics.getUserStorageStats(userId, function(error, StorageStats){
// do something
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
......@@ -526,13 +581,13 @@ getUserStorageStats(userId?: number, callback: AsyncCallback&lt;StorageStats&gt;
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics
该接口为系统接口，三方应用不支持调用
该接口为系统接口。
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | ---- | ----- | -------------- |
| total | number | 是 | 否 | 内卡总空间大小 |
| audio | number |是 | 否 | 音频数据大小 |
| video | number | 是 | 否 | 视频数据大小 |
| image | number | 是 | 否 | 图像数据大小 |
| file | number | 是 | 否 | 文件数据大小 |
| app | number | 是 | 否 | 应用数据大小 |
| total | number | 是 | 否 | 内置存储总空间大小（单位为Byte） |
| audio | number |是 | 否 | 音频数据大小 （单位为Byte） |
| video | number | 是 | 否 | 视频数据大小（单位为Byte） |
| image | number | 是 | 否 | 图像数据大小 （单位为Byte） |
| file | number | 是 | 否 | 文件数据大小 （单位为Byte） |
| app | number | 是 | 否 | 应用数据大小（单位为Byte） |
zh-cn/application-dev/reference/apis/js-apis-volumemanager.md → zh-cn/application-dev/reference/apis/js-apis-file-volumemanager.md
浏览文件 @ 4f52dcad
# @ohos.volumeManager (卷管理)
# @ohos.file.volumeManager (卷管理)
该模块提供卷、磁盘查询和管理的相关功能：包括查询卷信息，对卷的挂载卸载、对磁盘分区以及卷的格式化等功能。
> **说明：**
>
> - 本模块首批接口从API version 9开始支持。
> - 本模块接口为系统接口，三方应用不支持调用。
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
```js
import volumemanager from "@ohos.volumeManager";
import volumemanager from "@ohos.file.volumeManager";
```
## volumemanager.getAllVolumes
......@@ -65,7 +66,7 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
## volumemanager.mount
mount(volumeId: string): Promise&lt;boolean&gt;
mount(volumeId: string): Promise&lt;void&gt;
异步挂载指定卷，以promise方式返回。
......@@ -83,7 +84,7 @@ mount(volumeId: string): Promise&lt;boolean&gt;
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;boolean&gt; | 挂载指定卷 |
| Promise&lt;void&gt; | 挂载指定卷 |
**示例：**
......@@ -96,7 +97,7 @@ mount(volumeId: string): Promise&lt;boolean&gt;
## volumemanager.mount
mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
mount(volumeId: string, callback:AsyncCallback&lt;void&gt;):void
异步获取指定卷的可用空间大小，以callback方式返回。
......@@ -109,7 +110,7 @@ mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 挂载指定卷之后的回调 |
| callback | AsyncCallback&lt;void&gt; | 是 | 挂载指定卷之后的回调 |
**示例：**
......@@ -122,7 +123,7 @@ mount(volumeId: string, callback:AsyncCallback&lt;boolean&gt;):void
## volumemanager.unmount
unmount(volumeId: string): Promise&lt;boolean&gt;
unmount(volumeId: string): Promise&lt;void&gt;
异步卸载指定卷，以promise方式返回。
......@@ -140,7 +141,7 @@ unmount(volumeId: string): Promise&lt;boolean&gt;
| 类型 | 说明 |
| ---------------------- | ---------- |
| Promise&lt;boolean&gt; | 卸载指定卷 |
| Promise&lt;void&gt; | 卸载指定卷 |
**示例：**
......@@ -153,7 +154,7 @@ unmount(volumeId: string): Promise&lt;boolean&gt;
## volumemanager.unmount
unmount(volumeId: string, callback: AsyncCallback&lt;boolean&gt;): void
unmount(volumeId: string, callback: AsyncCallback&lt;void&gt;): void
异步卸载指定卷，以callback方式返回。
......@@ -166,7 +167,7 @@ unmount(volumeId: string, callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------- | ---- | -------------------- |
| volumeId | string | 是 | 卷id |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 卸载指定卷之后的回调 |
| callback | AsyncCallback&lt;void&gt; | 是 | 卸载指定卷之后的回调 |
**示例：**
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或