Skip to content

D
Docs

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

通知 159
Star 292
Fork 28
D
Docs
提交 8db8c2db 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 148438ff
展开全部 隐藏空白更改
内联 并排
Showing with 1814 addition and 520 deletion
zh-cn/application-dev/reference/apis/js-apis-file-cloudsyncmanager.md
浏览文件 @ 8db8c2db
......@@ -5,7 +5,6 @@
> **说明：**
> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口，三方应用不支持调用。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
......@@ -35,6 +34,15 @@ changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean): Pr
| --------------------- | ---------------- |
| Promise&lt;void&gt; | 使用Promise形式返回修改应用的端云文件同步开关的结果 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
**示例：**
```js
......@@ -64,6 +72,15 @@ changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean, cal
| status | boolean | 是 | 修改的应用云同步开关状态，true为打开，false为关闭|
| callback | AsyncCallback&lt;void&gt; | 是 | 异步修改应用的端云文件同步开关之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
**示例：**
```js
......@@ -77,6 +94,7 @@ changeAppCloudSwitch(accountId: string, bundleName: string, status: boolean, cal
}
});
```
## cloudSyncManager.notifyDataChange
notifyDataChange(accountId: string, bundleName: string): Promise&lt;void&gt;;
......@@ -98,6 +116,15 @@ notifyDataChange(accountId: string, bundleName: string): Promise&lt;void&gt;;
| --------------------- | ---------------- |
| Promise&lt;void&gt; | 使用Promise形式返回通知端云服务应用的云数据变更的结果 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
**示例：**
```js
......@@ -126,6 +153,15 @@ notifyDataChange(accountId: string, bundleName: string, callback: AsyncCallback&
| bundleName | string | 是 | 应用包名|
| callback | AsyncCallback&lt;void&gt; | 是 | 异步通知端云服务应用的云数据变更之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
**示例：**
```js
......
zh-cn/application-dev/reference/apis/js-apis-file-environment.md
浏览文件 @ 8db8c2db
......@@ -3,9 +3,9 @@
该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
> **说明：**
>
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口，三方应用不支持调用。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
......@@ -27,6 +27,15 @@ getStorageDataDir():Promise&lt;string&gt;
| --------------------- | ---------------- |
| Promise&lt;string&gt; | 返回存储根目录 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 202 | The caller is not a system application |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -51,6 +60,15 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
| -------- | --------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取内存存储根目录之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 202 | The caller is not a system application |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -77,6 +95,15 @@ getUserDataDir():Promise&lt;string&gt;
| --------------------- | ------------------ |
| Promise&lt;string&gt; | 返回公共文件根目录 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 202 | The caller is not a system application |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -101,6 +128,15 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
| -------- | --------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取公共文件根目录之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 202 | The caller is not a system application |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
......
zh-cn/application-dev/reference/apis/js-apis-file-fileuri.md
浏览文件 @ 8db8c2db
......@@ -3,7 +3,8 @@
该模块提供通过PATH获取文件统一资源标志符（Uniform Resource Identifier，URI），后续可通过使用[@ohos.file.fs](js-apis-file-fs.md)进行相关open、read、write等操作，实现文件分享。
> **说明：**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -46,11 +47,10 @@ getUriFromPath(path: string): string
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 401 | The input parameter is invalid |
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 401 | The input parameter is invalid |
**示例：**
......
zh-cn/application-dev/reference/apis/js-apis-file-hash.md
浏览文件 @ 8db8c2db
......@@ -3,8 +3,8 @@
该模块提供文件哈希处理能力，对文件内容进行哈希处理。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
......@@ -63,6 +63,15 @@ hash(path: string, algorithm: string): Promise&lt;string&gt;
| --------------------- | -------------------------- |
| Promise&lt;string&gt; | Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -90,7 +99,17 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo
| algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;或&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步计算文件哈希操作之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：**
```js
let filePath = pathDir + "/test.txt";
Hash.hash(filePath, "sha256", (err, str) => {
......
zh-cn/application-dev/reference/apis/js-apis-file-picker.md
浏览文件 @ 8db8c2db
......@@ -6,6 +6,7 @@
选择器(Picker)是一个封装PhotoViewPicker、DocumentViewPicker、AudioViewPicker等系统应用选择与保存能力的模块。应用可以自行选择使用哪种picker实现文件选择和文件保存的功能。
## 导入模块
```js
import picker from '@ohos.file.picker';
```
......@@ -30,7 +31,7 @@ select(option?: PhotoSelectOptions) : Promise&lt;PhotoSelectResult&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -70,7 +71,7 @@ select(option: PhotoSelectOptions, callback: AsyncCallback&lt;PhotoSelectResult&
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -107,7 +108,7 @@ select(callback: AsyncCallback&lt;PhotoSelectResult&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -140,7 +141,7 @@ save(option?: PhotoSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -179,7 +180,7 @@ save(option: PhotoSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -215,7 +216,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -260,7 +261,7 @@ select(option?: DocumentSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -298,7 +299,7 @@ select(option: DocumentSelectOptions, callback: AsyncCallback&lt;Array&lt;string
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -333,7 +334,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -367,7 +368,7 @@ save(option?: DocumentSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -406,7 +407,7 @@ save(option: DocumentSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -442,7 +443,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -487,7 +488,7 @@ select(option?: AudioSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -525,7 +526,7 @@ select(option: AudioSelectOptions, callback: AsyncCallback&lt;Array&lt;string&gt
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -560,7 +561,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -593,7 +594,7 @@ save(option?: AudioSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -632,7 +633,7 @@ save(option: AudioSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -668,7 +669,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-file-securityLabel.md
浏览文件 @ 8db8c2db
......@@ -3,8 +3,8 @@
该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
......@@ -63,6 +63,21 @@ setSecurityLabel(path:string, type:DataLevel):Promise&lt;void&gt;
| ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise实例，用于异步获取结果。本调用将返回空值。|
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -90,6 +105,21 @@ setSecurityLabel(path:string, type:DataLevel, callback: AsyncCallback&lt;void&gt
| type | DataLevel | 是 | 文件等级属性，只支持"s0","s1","s2","s3","s4" |
| callback | AsyncCallback&lt;void&gt; | 是 | 是否设置数据标签之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -118,6 +148,21 @@ setSecurityLabelSync(path:string, type:DataLevel):void
| path | string | 是 | 文件路径 |
| type | DataLevel | 是 | 文件等级属性，只支持"s0","s1","s2","s3","s4" |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -145,6 +190,21 @@ getSecurityLabel(path:string):Promise&lt;string&gt;
| --------------------- | ------------ |
| Promise&lt;string&gt; | 返回数据标签 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -171,6 +231,21 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
| path | string | 是 | 文件路径 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取数据标签之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......@@ -183,6 +258,7 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
}
});
```
## securityLabel.getSecurityLabelSync
getSecurityLabelSync(path:string):string
......@@ -203,6 +279,21 @@ getSecurityLabelSync(path:string):string
| ------ | ------------ |
| string | 返回数据标签 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900001 | Operation not permitted |
| 13900007 | Arg list too long |
| 13900015 | File exists |
| 13900020 | Invalid argument |
| 13900025 | No space left on device |
| 13900037 | No data available |
| 13900041 | Quota exceeded |
| 13900042 | Unknown error |
**示例：**
```js
......
zh-cn/application-dev/reference/apis/js-apis-file-statvfs.md
浏览文件 @ 8db8c2db
......@@ -3,14 +3,15 @@
该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
> **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
```js
import statvfs from '@ohos.file.statvfs';
```
## statvfs.getFreeSize
getFreeSize(path:string):Promise&lt;number&gt;
......@@ -31,6 +32,10 @@ getFreeSize(path:string):Promise&lt;number&gt;
| --------------------- | -------------- |
| Promise&lt;number&gt; | 返回空闲字节数 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：**
```js
......@@ -57,6 +62,10 @@ getFreeSize(path:string, callback:AsyncCallback&lt;number&gt;): void
| path | string | 是 | 需要查询的文件系统的文件路径 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步获取空闲字节数之后的回调 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：**
```js
......@@ -90,6 +99,10 @@ getTotalSize(path: string): Promise&lt;number&gt;
| --------------------- | ------------ |
| Promise&lt;number&gt; | 返回总字节数 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：**
```js
......@@ -116,6 +129,10 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void
| path | string | 是 | 需要查询的文件系统的文件路径 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步获取总字节数之后的回调 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：**
```js
......@@ -128,4 +145,3 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void
}
});
```
zh-cn/application-dev/reference/apis/js-apis-file-storage-statistics.md
浏览文件 @ 8db8c2db
......@@ -4,8 +4,8 @@
> **说明：**
>
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
```js
......@@ -36,6 +36,19 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回指定卷设备的总空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -66,6 +79,19 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷设备总空间之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -100,6 +126,19 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回指定卷的可用空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -131,6 +170,19 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -165,6 +217,19 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存储数据（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -195,6 +260,19 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
| packageName | string | 是 | 应用包名 |
| callback | AsyncCallback&lt;[Bundlestats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储数据之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -219,6 +297,16 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt;
| ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -240,6 +328,16 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[BundleStats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -259,7 +357,6 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| cacheSize | number | 是 | 否 | 缓存数据大小（单位为Byte） |
| dataSize | number | 是 | 否 | 应用总数据大小（单位为Byte） |
## storageStatistics.getTotalSize<sup>9+</sup>
getTotalSize(): Promise&lt;number&gt;
......@@ -278,6 +375,18 @@ getTotalSize(): Promise&lt;number&gt;
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的总空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -303,6 +412,18 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
| -------- | ------------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的总空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -330,6 +451,18 @@ getFreeSize(): Promise&lt;number&gt;
| --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的可用空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -355,6 +488,18 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void
| -------- | ------------------------------------ | ---- | ------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的可用空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -382,6 +527,18 @@ getSystemSize(): Promise&lt;number&gt;
| --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统数据的空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -410,6 +567,18 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取系统数据的空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -437,6 +606,18 @@ getUserStorageStats(): Promise&lt;StorageStats&gt;
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回当前用户各类别存储空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -465,6 +646,18 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void
| ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回用户各类别存储空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -473,6 +666,7 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
});
```
getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
异步获取指定用户各类别存储空间大小（单位为Byte），以promise方式返回。
......@@ -495,6 +689,19 @@ getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
| --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回指定用户各类别存储空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600009 | User if out of range. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -525,6 +732,19 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;)
| userId | number | 是 | 用户id |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回各类别数据大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600009 | User if out of range. |
| 13900032 | Unknown error. |
**示例：**
```js
......
zh-cn/application-dev/reference/apis/js-apis-file-volumemanager.md
浏览文件 @ 8db8c2db
......@@ -6,7 +6,6 @@
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块
......@@ -30,6 +29,18 @@ getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)[]&gt; | 返回当前所有可获得的卷设备信息 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -56,6 +67,18 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
| -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷设备信息之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -65,7 +88,6 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
});
```
## volumemanager.mount
mount(volumeId: string): Promise&lt;void&gt;
......@@ -88,6 +110,22 @@ mount(volumeId: string): Promise&lt;void&gt;
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 挂载指定卷设备 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600003 | Failed to mount. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -116,6 +154,22 @@ mount(volumeId: string, callback:AsyncCallback&lt;void&gt;):void
| volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;void&gt; | 是 | 挂载指定卷设备之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600003 | Failed to mount. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -147,6 +201,22 @@ unmount(volumeId: string): Promise&lt;void&gt;
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 卸载指定卷设备 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600004 | Failed to unmount. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -175,6 +245,22 @@ unmount(volumeId: string, callback: AsyncCallback&lt;void&gt;): void
| volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;void&gt; | 是 | 卸载指定卷设备之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600004 | Failed to unmount. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -206,6 +292,19 @@ getVolumeByUuid(uuid: string): Promise&lt;Volume&gt;
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷设备信息 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -234,6 +333,19 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void
| uuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷设备信息之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -265,6 +377,19 @@ getVolumeById(volumeId: string): Promise&lt;Volume&gt;
| ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#volume)&gt; | 返回当前所有可获得的卷设备信息 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -293,6 +418,19 @@ getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void
| volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷设备信息之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -325,6 +463,21 @@ setVolumeDescription(uuid: string, description: string): Promise&lt;void&gt;
| ---------------------- | -------------------------- |
| Promise&lt;void&gt; | 设置卷设备信息 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -355,6 +508,21 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback&
| description | string | 是 | 卷设备描述 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -388,6 +556,21 @@ format(volumeId: string, fsType: string): Promise&lt;void&gt;
| ---------------------- | ---------- |
| Promise&lt;void&gt; | 对指定卷设备进行格式化 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -418,6 +601,21 @@ format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): v
| fsType | string | 是 | 文件系统类型(vfat或者exfat) |
| callback | AsyncCallback&lt;void&gt; | 是 | 对指定卷设备格式化后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600002 | Not supported filesystem. |
| 13600005 | Incorrect volume state. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -451,6 +649,19 @@ partition(diskId: string, type: number): Promise&lt;void&gt;
| --------------------- | ----------------------- |
| Promise&lt;void&gt; | 对磁盘进行分区 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......@@ -481,6 +692,19 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo
| type | number | 是 | 分区类型 |
| callback | AsyncCallback&lt;void&gt; | 是 | 对磁盘设备进行分区 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 201 | Permission verification failed. |
| 202 | The caller is not a system application. |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13600008 | No such object. |
| 13900032 | Unknown error. |
**示例：**
```js
......
zh-cn/application-dev/reference/apis/js-apis-fileShare.md
浏览文件 @ 8db8c2db
......@@ -3,7 +3,8 @@
该模块提供文件分享能力，提供系统应用将公共目录文件统一资源标志符（Uniform Resource Identifier，URI）以读写权限授权给其他应用的接口，授权后应用可通过[@ohos.file.fs](js-apis-file-fs.md)的相关接口进行相关open、read、write等操作，实现文件分享。
> **说明：**
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块
......@@ -16,8 +17,11 @@ import fileShare from '@ohos.fileShare';
grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
对公共目录文件URI进行授权操作，使用callback异步回调。
**需要权限**：ohos.permission.WRITE_MEDIA
**系统接口**：此接口为系统接口
**系统能力**：SystemCapability.FileManagement.AppFileService
**参数：**
......@@ -31,15 +35,14 @@ grantUriPermission(uri: string, bundleName: string, mode: number, callback: Asyn
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例：**
......@@ -62,14 +65,16 @@ try {
}
```
## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;void&gt;
将公共目录文件URI进行授权操作，使用Promise异步回调。
**需要权限**：ohos.permission.WRITE_MEDIA
**系统接口**：此接口为系统接口
**系统能力**：SystemCapability.FileManagement.AppFileService
**参数：**
......@@ -86,18 +91,16 @@ grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;vo
| ---------------------------- | ---------- |
| Promise&lt;void&gt; | Promise对象，无返回值 |
**错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| ---------------------------- | ---------- |
| 201 | Permission verification failed |
| 202 | The caller is not a system application |
| 401 | The input parameter is invalid |
| 143000001 | IPC error |
**示例：**
......@@ -116,4 +119,4 @@ try {
} catch (error) {
console.error("grantUriPermission failed with error:" + error);
}
```
\ No newline at end of file
```
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
浏览文件 @ 8db8c2db
......@@ -3,8 +3,9 @@
该模块提供用户数据管理能力，包括访问、修改用户等用户公共媒体数据信息等常用功能。
> **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块接口为系统接口。
>
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
## 导入模块
......@@ -22,7 +23,7 @@ getUserFileMgr(context: Context): UserFileManager
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**参数：**
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- |
......@@ -48,11 +49,8 @@ let mgr = userFileManager.getUserFileMgr(context);
getPhotoAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;
获取图片和视频资源，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**需要权限**：ohos.permission.READ_IMAGEVIDEO
......@@ -91,7 +89,6 @@ async function example() {
}
```
### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
......@@ -108,7 +105,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| ------- | ------------------- | ---- | ---------------- |
| options | [FetchOptions](#fetchoptions) | 是 | 图片和视频检索选项 |
**返回值**
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
......@@ -140,6 +137,7 @@ async function example() {
}
}
```
### createPhotoAsset
createPhotoAsset(displayName: string, albumUri: string, callback: AsyncCallback&lt;FileAsset&gt;): void;
......@@ -234,7 +232,7 @@ createPhotoAsset(displayName: string, albumUri?: string): Promise&lt;FileAsset&g
| displayName | string | 是 | 创建的图片或者视频文件名 |
| albumUri | string | 否 | 创建的图片或者视频所在相册的uri |
**返回值**
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
......@@ -260,7 +258,6 @@ async function example() {
getPhotoAlbums(options: AlbumFetchOptions, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void;
获取相册，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
......@@ -319,7 +316,7 @@ getPhotoAlbums(options: AlbumFetchOptions): Promise&lt;FetchResult&lt;Album&gt;&
| -------- | ------------------------ | ---- | ------------------------- |
| options | [AlbumFetchOptions](#albumfetchoptions) | 是 | 相册检索选项 |
**返回值**
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
......@@ -351,7 +348,6 @@ async function example() {
getPrivateAlbum(type: PrivateAlbumType, callback: AsyncCallback&lt;FetchResult&lt;PrivateAlbum&gt;&gt;): void;
获取系统相册，使用 callback 方式返回系统相册的数组。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
......@@ -398,7 +394,7 @@ getPrivateAlbum(type: PrivateAlbumType): Promise&lt;FetchResult&lt;PrivateAlbum&
| -------- | ------------------------ | ---- | ------------------------- |
| type | [PrivateAlbumType](#privatealbumtype) | 是 | 系统相册类型 |
**返回值**
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
......@@ -423,7 +419,6 @@ async function example() {
getAudioAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;
获取音频文件，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
......@@ -468,7 +463,6 @@ async function example() {
getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
获取音频文件，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
......@@ -481,7 +475,7 @@ getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| -------- | ------------------------ | ---- | ------------------------- |
| options | [FetchOptions](#fetchoptions) | 是 | 检索选项 |
**返回值**
**返回值：**
| 类型 | 说明 |
| --------------------------- | -------------- |
......@@ -514,6 +508,7 @@ async function example() {
}
}
```
### delete
delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;
......@@ -563,6 +558,7 @@ async function example() {
});
}
```
### delete
delete(uri: string): Promise&lt;void&gt;;
......@@ -579,7 +575,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 媒体文件uri |
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -1092,7 +1088,6 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void
**需要权限**：ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 或 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**参数**
......@@ -1482,7 +1477,7 @@ getCount(): number
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| ------ | -------- |
......@@ -1514,7 +1509,7 @@ isAfterLast(): boolean
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| ------- | ---------------------------------- |
......@@ -1618,7 +1613,7 @@ getFirstObject(): Promise&lt;T&gt;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | -------------------------- |
......@@ -1690,7 +1685,7 @@ async function example() {
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -1762,7 +1757,7 @@ getLastObject(): Promise&lt;T&gt;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -1838,7 +1833,7 @@ getPositionObject(index: number): Promise&lt;T&gt;
| ----- | ------ | ---- | -------------- |
| index | number | 是 | 要获取的文件的索引，从0开始 |
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -1922,6 +1917,7 @@ async function example() {
});
}
```
### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
......@@ -2015,7 +2011,7 @@ commitModify(): Promise&lt;void&gt;;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**：
**返回值：**：
| 类型 | 说明 |
| ------------------- | ------------ |
......@@ -2105,6 +2101,7 @@ async function example() {
}
```
### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
......@@ -2121,7 +2118,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| -------- | ------------------------- | ---- | ---------- |
| options | [FetchOptions](#fetchoptions) | 是 | 检索选项 |
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -2146,6 +2143,7 @@ async function example() {
console.info('fetchResult.count = ', count);
}
```
### delete
delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;
......@@ -2189,6 +2187,7 @@ async function example() {
});
}
```
### delete
delete(uri: string): Promise&lt;void&gt;;
......@@ -2205,7 +2204,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri |
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -2279,6 +2278,7 @@ async function example() {
});
}
```
### recover
recover(uri: string): Promise&lt;void&gt;;
......@@ -2295,7 +2295,7 @@ recover(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri |
**返回值**：
**返回值：**：
| 类型 | 说明 |
| --------------------------------------- | ----------------- |
......@@ -2334,9 +2334,9 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ---- | ---- | ---- | ---- |
| number | number | 是 | 是 | number类型 |
| string | string | 是 | 是 | string类型 |
| boolean | boolean | 是 | 是 | boolean类型 |
| number | number | 是 | 是 | number类型 |
| string | string | 是 | 是 | string类型 |
| boolean | boolean | 是 | 是 | boolean类型 |
## ChangeEvent
......@@ -2365,7 +2365,6 @@ async function example() {
| networkId | string | 是 | 否 | 注册设备的网络ID |
| isOnline | boolean | 是 | 否 | 是否在线 |
## FileType
枚举，媒体文件类型。
......@@ -2389,8 +2388,6 @@ async function example() {
| TYPE_FAVORITE | 0 | 收藏夹相册 |
| TYPE_TRASH | 1 | 回收站相册 |
## AudioKey
枚举，音频文件关键信息。
......@@ -2444,7 +2441,6 @@ async function example() {
| DATE_ADDED | date_added | 添加日期（添加文件时间到1970年1月1日的秒数值） |
| DATE_MODIFIED | date_modified | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新） |
## FetchOptions
检索条件。
......@@ -2465,4 +2461,3 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------- | ------------------- | ---- |---- | ------------------------------------------------ |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md) | 是 | 是 | 谓词查询，显示过滤条件 |
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或