Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 7831ae63 编写于 作者: Z zengyawen
浏览文件
操作

update docs 

Signed-off-by: Nzengyawen <zengyawen1@huawei.com>
上级 827b1c9c
隐藏空白更改
内联 并排
Showing with 1559 addition and 494 deletion
zh-cn/application-dev/reference/apis/js-apis-file-environment.md
浏览文件 @ 7831ae63
...@@ -3,9 +3,9 @@ ...@@ -3,9 +3,9 @@
该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。 该模块提供环境目录能力，获取内存存储根目录、公共文件根目录的JS接口。
> **说明：** > **说明：**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >
> 本模块接口为系统接口，三方应用不支持调用。 > - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。 > - 本模块接口为系统接口，三方应用不支持调用。
## 导入模块 ## 导入模块
...@@ -27,6 +27,15 @@ getStorageDataDir():Promise&lt;string&gt; ...@@ -27,6 +27,15 @@ getStorageDataDir():Promise&lt;string&gt;
| --------------------- | ---------------- | | --------------------- | ---------------- |
| 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 ```js
...@@ -51,6 +60,15 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void ...@@ -51,6 +60,15 @@ getStorageDataDir(callback:AsyncCallback&lt;string&gt;):void
| -------- | --------------------------- | ---- | -------------------------------- | | -------- | --------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取内存存储根目录之后的回调 | | 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 ```js
...@@ -77,6 +95,15 @@ getUserDataDir():Promise&lt;string&gt; ...@@ -77,6 +95,15 @@ getUserDataDir():Promise&lt;string&gt;
| --------------------- | ------------------ | | --------------------- | ------------------ |
| 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 ```js
...@@ -101,6 +128,15 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void ...@@ -101,6 +128,15 @@ getUserDataDir(callback:AsyncCallback&lt;string&gt;): void
| -------- | --------------------------- | ---- | -------------------------------- | | -------- | --------------------------- | ---- | -------------------------------- |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取公共文件根目录之后的回调 | | 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 ```js
......
zh-cn/application-dev/reference/apis/js-apis-file-fileuri.md
浏览文件 @ 7831ae63
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
该模块提供通过PATH获取文件统一资源标志符（Uniform Resource Identifier，URI），后续可通过使用[@ohos.file.fs](js-apis-file-fs.md)进行相关open、read、write等操作，实现文件分享。 该模块提供通过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 ...@@ -46,11 +47,10 @@ getUriFromPath(path: string): string
**错误码：** **错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导) 以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 | | 错误码ID | 错误信息 |
| ---------------------------- | ---------- | | ---------------------------- | ---------- |
| 401 | The input parameter is invalid | | 401 | The input parameter is invalid |
**示例：** **示例：**
......
zh-cn/application-dev/reference/apis/js-apis-file-fs.md
浏览文件 @ 7831ae63
...@@ -3,6 +3,7 @@ ...@@ -3,6 +3,7 @@
该模块为基础文件操作API，提供基础文件操作能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。 该模块为基础文件操作API，提供基础文件操作能力，包括文件基本管理、文件目录管理、文件信息统计、文件流式读写等常用功能。
> **说明：** > **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
## 导入模块 ## 导入模块
...@@ -11,10 +12,6 @@ ...@@ -11,10 +12,6 @@
import fs from '@ohos.file.fs'; import fs from '@ohos.file.fs';
``` ```
## 错误码说明
本模块支持对错误码进行处理，错误码及其适配方式请参考文档：[文件管理错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 使用说明 ## 使用说明
使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考： 使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：
...@@ -65,6 +62,10 @@ stat(file: string|number): Promise&lt;Stat&gt; ...@@ -65,6 +62,10 @@ stat(file: string|number): Promise&lt;Stat&gt;
| ---------------------------- | ---------- | | ---------------------------- | ---------- |
| Promise&lt;[Stat](#stat)&gt; | Promise对象。返回文件的具体信息。 | | Promise&lt;[Stat](#stat)&gt; | Promise对象。返回文件的具体信息。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -91,6 +92,10 @@ stat(file: string|number, callback: AsyncCallback&lt;Stat&gt;): void ...@@ -91,6 +92,10 @@ stat(file: string|number, callback: AsyncCallback&lt;Stat&gt;): void
| file | string\|number | 是 | 文件应用沙箱路径path或已打开的文件描述符fd。 | | file | string\|number | 是 | 文件应用沙箱路径path或已打开的文件描述符fd。 |
| callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取文件的信息之后的回调。 | | callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 异步获取文件的信息之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -117,13 +122,16 @@ statSync(file: string|number): Stat ...@@ -117,13 +122,16 @@ statSync(file: string|number): Stat
| ------ | ------ | ---- | -------------------------- | | ------ | ------ | ---- | -------------------------- |
| file | string\|number | 是 | 文件应用沙箱路径path或已打开的文件描述符fd。 | | file | string\|number | 是 | 文件应用沙箱路径path或已打开的文件描述符fd。 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------- | ---------- | | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 | | [Stat](#stat) | 表示文件的具体信息。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -151,6 +159,10 @@ access(path: string): Promise&lt;boolean&gt; ...@@ -151,6 +159,10 @@ access(path: string): Promise&lt;boolean&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;boolean&gt; | Promise对象。返回boolean，表示文件是否存在。 | | Promise&lt;boolean&gt; | Promise对象。返回boolean，表示文件是否存在。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -164,7 +176,6 @@ access(path: string): Promise&lt;boolean&gt; ...@@ -164,7 +176,6 @@ access(path: string): Promise&lt;boolean&gt;
}); });
``` ```
## fs.access ## fs.access
access(path: string, callback: AsyncCallback&lt;boolean&gt;): void access(path: string, callback: AsyncCallback&lt;boolean&gt;): void
...@@ -178,7 +189,11 @@ access(path: string, callback: AsyncCallback&lt;boolean&gt;): void ...@@ -178,7 +189,11 @@ access(path: string, callback: AsyncCallback&lt;boolean&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------- | ---- | ------------------------------------------------------------ | | -------- | ------------------------- | ---- | ------------------------------------------------------------ |
| path | string | 是 | 文件应用沙箱路径。 | | path | string | 是 | 文件应用沙箱路径。 |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 异步检查文件是否存在的回调。 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 异步检查文件是否存在的回调，如果存在，回调返回true，否则返回false。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
...@@ -213,7 +228,11 @@ accessSync(path: string): boolean ...@@ -213,7 +228,11 @@ accessSync(path: string): boolean
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| boolean | 返回boolean，表示文件是否存在。 | | boolean | 返回true，表示文件存在；返回false，表示文件不存在。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
...@@ -250,6 +269,10 @@ close(file: File|number): Promise&lt;void&gt; ...@@ -250,6 +269,10 @@ close(file: File|number): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -278,6 +301,10 @@ close(file: File|number, callback: AsyncCallback&lt;void&gt;): void ...@@ -278,6 +301,10 @@ close(file: File|number, callback: AsyncCallback&lt;void&gt;): void
| file | [File](#file)\|number | 是 | 已打开的File对象或已打开的文件描述符fd。 | | file | [File](#file)\|number | 是 | 已打开的File对象或已打开的文件描述符fd。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -306,6 +333,10 @@ closeSync(file: File|number): void ...@@ -306,6 +333,10 @@ closeSync(file: File|number): void
| ---- | ------ | ---- | ------------ | | ---- | ------ | ---- | ------------ |
| file | [File](#file)\|number | 是 | 已打开的File对象或已打开的文件描述符fd。 | | file | [File](#file)\|number | 是 | 已打开的File对象或已打开的文件描述符fd。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -336,6 +367,10 @@ copyFile(src: string|number, dest: string|number, mode?: number): Promise&lt;voi ...@@ -336,6 +367,10 @@ copyFile(src: string|number, dest: string|number, mode?: number): Promise&lt;voi
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -365,6 +400,10 @@ copyFile(src: string|number, dest: string|number, mode?: number, callback: Async ...@@ -365,6 +400,10 @@ copyFile(src: string|number, dest: string|number, mode?: number, callback: Async
| mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。<br/>0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。<br/>0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步复制文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步复制文件之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -396,6 +435,10 @@ copyFileSync(src: string|number, dest: string|number, mode?: number): void ...@@ -396,6 +435,10 @@ copyFileSync(src: string|number, dest: string|number, mode?: number): void
| dest | string\|number | 是 | 目标文件路径或目标文件的文件描述符。 | | dest | string\|number | 是 | 目标文件路径或目标文件的文件描述符。 |
| mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。<br/>0：完全覆盖目标文件，未覆盖部分将被裁切掉。 | | mode | number | 否 | mode提供覆盖文件的选项，当前仅支持0，且默认为0。<br/>0：完全覆盖目标文件，未覆盖部分将被裁切掉。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -404,7 +447,6 @@ copyFileSync(src: string|number, dest: string|number, mode?: number): void ...@@ -404,7 +447,6 @@ copyFileSync(src: string|number, dest: string|number, mode?: number): void
fs.copyFileSync(srcPath, dstPath); fs.copyFileSync(srcPath, dstPath);
``` ```
## fs.mkdir ## fs.mkdir
mkdir(path: string): Promise&lt;void&gt; mkdir(path: string): Promise&lt;void&gt;
...@@ -425,6 +467,10 @@ mkdir(path: string): Promise&lt;void&gt; ...@@ -425,6 +467,10 @@ mkdir(path: string): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -436,7 +482,6 @@ mkdir(path: string): Promise&lt;void&gt; ...@@ -436,7 +482,6 @@ mkdir(path: string): Promise&lt;void&gt;
}); });
``` ```
## fs.mkdir ## fs.mkdir
mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -452,6 +497,10 @@ mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -452,6 +497,10 @@ mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void
| path | string | 是 | 目录的应用沙箱路径。 | | path | string | 是 | 目录的应用沙箱路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步创建目录操作完成之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步创建目录操作完成之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -465,7 +514,6 @@ mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -465,7 +514,6 @@ mkdir(path: string, callback: AsyncCallback&lt;void&gt;): void
}); });
``` ```
## fs.mkdirSync ## fs.mkdirSync
mkdirSync(path: string): void mkdirSync(path: string): void
...@@ -480,6 +528,10 @@ mkdirSync(path: string): void ...@@ -480,6 +528,10 @@ mkdirSync(path: string): void
| ------ | ------ | ---- | ------------------------------------------------------------ | | ------ | ------ | ---- | ------------------------------------------------------------ |
| path | string | 是 | 目录的应用沙箱路径。 | | path | string | 是 | 目录的应用沙箱路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -487,7 +539,6 @@ mkdirSync(path: string): void ...@@ -487,7 +539,6 @@ mkdirSync(path: string): void
fs.mkdirSync(dirPath); fs.mkdirSync(dirPath);
``` ```
## fs.open ## fs.open
open(path: string, mode?: number): Promise&lt;File&gt; open(path: string, mode?: number): Promise&lt;File&gt;
...@@ -509,6 +560,10 @@ open(path: string, mode?: number): Promise&lt;File&gt; ...@@ -509,6 +560,10 @@ open(path: string, mode?: number): Promise&lt;File&gt;
| --------------------- | ----------- | | --------------------- | ----------- |
| Promise&lt;[File](#file)&gt; | Promise对象。返回File对象。 | | Promise&lt;[File](#file)&gt; | Promise对象。返回File对象。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -536,6 +591,10 @@ open(path: string, mode?: number, callback: AsyncCallback&lt;File&gt;): void ...@@ -536,6 +591,10 @@ open(path: string, mode?: number, callback: AsyncCallback&lt;File&gt;): void
| path | string | 是 | 文件的应用沙箱路径或URI。 | | path | string | 是 | 文件的应用沙箱路径或URI。 |
| mode | number | 否 | 打开文件的[选项](#openmode)，必须指定如下选项中的一个，默认以只读方式打开：<br/>-&nbsp;OpenMode.READ_ONLY(0o0)：只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1)：只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2)：读写打开。<br/>给定如下功能选项，以按位或的方式追加，默认不给定任何额外选项：<br/>-&nbsp;OpenMode.CREATE(0o100)：若文件不存在，则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000)：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000)：以追加方式打开，后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000)：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000)：如果path不指向目录，则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000)：如果path指向符号链接，则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000)：以同步IO的方式打开文件。 | | mode | number | 否 | 打开文件的[选项](#openmode)，必须指定如下选项中的一个，默认以只读方式打开：<br/>-&nbsp;OpenMode.READ_ONLY(0o0)：只读打开。<br/>-&nbsp;OpenMode.WRITE_ONLY(0o1)：只写打开。<br/>-&nbsp;OpenMode.READ_WRITE(0o2)：读写打开。<br/>给定如下功能选项，以按位或的方式追加，默认不给定任何额外选项：<br/>-&nbsp;OpenMode.CREATE(0o100)：若文件不存在，则创建文件。<br/>-&nbsp;OpenMode.TRUNC(0o1000)：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。<br/>-&nbsp;OpenMode.APPEND(0o2000)：以追加方式打开，后续写将追加到文件末尾。<br/>-&nbsp;OpenMode.NONBLOCK(0o4000)：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续&nbsp;IO&nbsp;进行非阻塞操作。<br/>-&nbsp;OpenMode.DIR(0o200000)：如果path不指向目录，则出错。<br/>-&nbsp;OpenMode.NOFOLLOW(0o400000)：如果path指向符号链接，则出错。<br/>-&nbsp;OpenMode.SYNC(0o4010000)：以同步IO的方式打开文件。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -570,6 +629,10 @@ openSync(path: string, mode?: number): File ...@@ -570,6 +629,10 @@ openSync(path: string, mode?: number): File
| ------ | ----------- | | ------ | ----------- |
| [File](#file) | 打开的File对象。 | | [File](#file) | 打开的File对象。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -601,6 +664,10 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb ...@@ -601,6 +664,10 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb
| ---------------------------------- | ------ | | ---------------------------------- | ------ |
| Promise&lt;number&gt; | Promise对象。返回读取的结果。 | | Promise&lt;number&gt; | Promise对象。返回读取的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -633,6 +700,10 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb ...@@ -633,6 +700,10 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度。| | options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读。<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度。|
| callback | AsyncCallback&lt;number&gt; | 是 | 异步读取数据之后的回调。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步读取数据之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -650,7 +721,6 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb ...@@ -650,7 +721,6 @@ read(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: numb
}); });
``` ```
## fs.readSync ## fs.readSync
readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): number
...@@ -673,6 +743,10 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: ...@@ -673,6 +743,10 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?:
| ------ | -------- | | ------ | -------- |
| number | 实际读取的长度。 | | number | 实际读取的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -683,7 +757,6 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?: ...@@ -683,7 +757,6 @@ readSync(fd: number, buffer: ArrayBuffer, options?: { offset?: number; length?:
fs.closeSync(file); fs.closeSync(file);
``` ```
## fs.rmdir ## fs.rmdir
rmdir(path: string): Promise&lt;void&gt; rmdir(path: string): Promise&lt;void&gt;
...@@ -704,6 +777,10 @@ rmdir(path: string): Promise&lt;void&gt; ...@@ -704,6 +777,10 @@ rmdir(path: string): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -715,7 +792,6 @@ rmdir(path: string): Promise&lt;void&gt; ...@@ -715,7 +792,6 @@ rmdir(path: string): Promise&lt;void&gt;
}); });
``` ```
## fs.rmdir ## fs.rmdir
rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -731,6 +807,10 @@ rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -731,6 +807,10 @@ rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void
| path | string | 是 | 目录的应用沙箱路径。 | | path | string | 是 | 目录的应用沙箱路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步删除目录之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步删除目录之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -744,7 +824,6 @@ rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -744,7 +824,6 @@ rmdir(path: string, callback: AsyncCallback&lt;void&gt;): void
}); });
``` ```
## fs.rmdirSync ## fs.rmdirSync
rmdirSync(path: string): void rmdirSync(path: string): void
...@@ -759,6 +838,10 @@ rmdirSync(path: string): void ...@@ -759,6 +838,10 @@ rmdirSync(path: string): void
| ------ | ------ | ---- | -------------------------- | | ------ | ------ | ---- | -------------------------- |
| path | string | 是 | 目录的应用沙箱路径。 | | path | string | 是 | 目录的应用沙箱路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -766,7 +849,6 @@ rmdirSync(path: string): void ...@@ -766,7 +849,6 @@ rmdirSync(path: string): void
fs.rmdirSync(dirPath); fs.rmdirSync(dirPath);
``` ```
## fs.unlink ## fs.unlink
unlink(path: string): Promise&lt;void&gt; unlink(path: string): Promise&lt;void&gt;
...@@ -787,6 +869,10 @@ unlink(path: string): Promise&lt;void&gt; ...@@ -787,6 +869,10 @@ unlink(path: string): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -798,7 +884,6 @@ unlink(path: string): Promise&lt;void&gt; ...@@ -798,7 +884,6 @@ unlink(path: string): Promise&lt;void&gt;
}); });
``` ```
## fs.unlink ## fs.unlink
unlink(path: string, callback: AsyncCallback&lt;void&gt;): void unlink(path: string, callback: AsyncCallback&lt;void&gt;): void
...@@ -814,6 +899,10 @@ unlink(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -814,6 +899,10 @@ unlink(path: string, callback: AsyncCallback&lt;void&gt;): void
| path | string | 是 | 文件的应用沙箱路径。 | | path | string | 是 | 文件的应用沙箱路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步删除文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步删除文件之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -827,7 +916,6 @@ unlink(path: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -827,7 +916,6 @@ unlink(path: string, callback: AsyncCallback&lt;void&gt;): void
}); });
``` ```
## fs.unlinkSync ## fs.unlinkSync
unlinkSync(path: string): void unlinkSync(path: string): void
...@@ -842,6 +930,10 @@ unlinkSync(path: string): void ...@@ -842,6 +930,10 @@ unlinkSync(path: string): void
| ------ | ------ | ---- | -------------------------- | | ------ | ------ | ---- | -------------------------- |
| path | string | 是 | 文件的应用沙箱路径。 | | path | string | 是 | 文件的应用沙箱路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -872,6 +964,10 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt ...@@ -872,6 +964,10 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt
| --------------------- | -------- | | --------------------- | -------- |
| Promise&lt;number&gt; | Promise对象。返回实际写入的长度。 | | Promise&lt;number&gt; | Promise对象。返回实际写入的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -885,7 +981,6 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt ...@@ -885,7 +981,6 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt
}); });
``` ```
## fs.write ## fs.write
write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;number&gt;): void write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;number&gt;): void
...@@ -903,6 +998,10 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt ...@@ -903,6 +998,10 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。<br/>-&nbsp;length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认&nbsp;'utf-8'。当前仅支持&nbsp;'utf-8'。| | options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。<br/>-&nbsp;length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认&nbsp;'utf-8'。当前仅支持&nbsp;'utf-8'。|
| callback | AsyncCallback&lt;number&gt; | 是 | 异步将数据写入完成后执行的回调函数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步将数据写入完成后执行的回调函数。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -918,7 +1017,6 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt ...@@ -918,7 +1017,6 @@ write(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; lengt
}); });
``` ```
## fs.writeSync ## fs.writeSync
writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }): number
...@@ -941,6 +1039,10 @@ writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; l ...@@ -941,6 +1039,10 @@ writeSync(fd: number, buffer: ArrayBuffer|string, options?: { offset?: number; l
| ------ | -------- | | ------ | -------- |
| number | 实际写入的长度。 | | number | 实际写入的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -972,6 +1074,10 @@ truncate(file: string|number, len?: number): Promise&lt;void&gt; ...@@ -972,6 +1074,10 @@ truncate(file: string|number, len?: number): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -984,7 +1090,6 @@ truncate(file: string|number, len?: number): Promise&lt;void&gt; ...@@ -984,7 +1090,6 @@ truncate(file: string|number, len?: number): Promise&lt;void&gt;
}); });
``` ```
## fs.truncate ## fs.truncate
truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;): void truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;): void
...@@ -1001,6 +1106,10 @@ truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;) ...@@ -1001,6 +1106,10 @@ truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;)
| len | number | 否 | 文件截断后的长度，以字节为单位。默认为0。 | | len | number | 否 | 文件截断后的长度，以字节为单位。默认为0。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，本调用无返回值。 | | callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，本调用无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1015,7 +1124,6 @@ truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;) ...@@ -1015,7 +1124,6 @@ truncate(file: string|number, len?: number, callback: AsyncCallback&lt;void&gt;)
}); });
``` ```
## fs.truncateSync ## fs.truncateSync
truncateSync(file: string|number, len?: number): void truncateSync(file: string|number, len?: number): void
...@@ -1031,6 +1139,10 @@ truncateSync(file: string|number, len?: number): void ...@@ -1031,6 +1139,10 @@ truncateSync(file: string|number, len?: number): void
| file | string\|number | 是 | 文件的应用沙箱路径或已打开的文件描述符fd。 | | file | string\|number | 是 | 文件的应用沙箱路径或已打开的文件描述符fd。 |
| len | number | 否 | 文件截断后的长度，以字节为单位。默认为0。 | | len | number | 否 | 文件截断后的长度，以字节为单位。默认为0。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1039,7 +1151,6 @@ truncateSync(file: string|number, len?: number): void ...@@ -1039,7 +1151,6 @@ truncateSync(file: string|number, len?: number): void
fs.truncateSync(filePath, len); fs.truncateSync(filePath, len);
``` ```
## fs.readText ## fs.readText
readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): Promise&lt;string&gt; readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): Promise&lt;string&gt;
...@@ -1061,6 +1172,10 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin ...@@ -1061,6 +1172,10 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin
| --------------------- | ---------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | Promise对象。返回读取文件的内容。 | | Promise&lt;string&gt; | Promise对象。返回读取文件的内容。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1072,7 +1187,6 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin ...@@ -1072,7 +1187,6 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin
}); });
``` ```
## fs.readText ## fs.readText
readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;string&gt;): void readText(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;string&gt;): void
...@@ -1089,6 +1203,10 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin ...@@ -1089,6 +1203,10 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认文件长度。<br/>-&nbsp;encoding，string类型，表示数据的编码方式，默认&nbsp;'utf-8'，仅支持&nbsp;'utf-8'。 | | options | Object | 否 | 支持如下选项：<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认文件长度。<br/>-&nbsp;encoding，string类型，表示数据的编码方式，默认&nbsp;'utf-8'，仅支持&nbsp;'utf-8'。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回读取文件的内容。 | | callback | AsyncCallback&lt;string&gt; | 是 | 回调函数，返回读取文件的内容。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1102,7 +1220,6 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin ...@@ -1102,7 +1220,6 @@ readText(filePath: string, options?: { offset?: number; length?: number; encodin
}); });
``` ```
## fs.readTextSync ## fs.readTextSync
readTextSync(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): string readTextSync(filePath: string, options?: { offset?: number; length?: number; encoding?: string; }): string
...@@ -1124,6 +1241,10 @@ readTextSync(filePath: string, options?: { offset?: number; length?: number; enc ...@@ -1124,6 +1241,10 @@ readTextSync(filePath: string, options?: { offset?: number; length?: number; enc
| ------ | -------------------- | | ------ | -------------------- |
| string | 返回读取文件的内容。 | | string | 返回读取文件的内容。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1152,6 +1273,10 @@ lstat(path: string): Promise&lt;Stat&gt; ...@@ -1152,6 +1273,10 @@ lstat(path: string): Promise&lt;Stat&gt;
| ---------------------------- | ---------- | | ---------------------------- | ---------- |
| Promise&lt;[Stat](#stat)&gt; | promise对象，返回文件对象，表示文件的具体信息，详情见stat。 | | Promise&lt;[Stat](#stat)&gt; | promise对象，返回文件对象，表示文件的具体信息，详情见stat。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1163,7 +1288,6 @@ lstat(path: string): Promise&lt;Stat&gt; ...@@ -1163,7 +1288,6 @@ lstat(path: string): Promise&lt;Stat&gt;
}); });
``` ```
## fs.lstat ## fs.lstat
lstat(path: string, callback: AsyncCallback&lt;Stat&gt;): void lstat(path: string, callback: AsyncCallback&lt;Stat&gt;): void
...@@ -1179,6 +1303,10 @@ lstat(path: string, callback: AsyncCallback&lt;Stat&gt;): void ...@@ -1179,6 +1303,10 @@ lstat(path: string, callback: AsyncCallback&lt;Stat&gt;): void
| path | string | 是 | 文件的应用沙箱路径。 | | path | string | 是 | 文件的应用沙箱路径。 |
| callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 回调函数，返回文件的具体信息。 | | callback | AsyncCallback&lt;[Stat](#stat)&gt; | 是 | 回调函数，返回文件的具体信息。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1212,6 +1340,10 @@ lstatSync(path: string): Stat ...@@ -1212,6 +1340,10 @@ lstatSync(path: string): Stat
| ------------- | ---------- | | ------------- | ---------- |
| [Stat](#stat) | 表示文件的具体信息。 | | [Stat](#stat) | 表示文件的具体信息。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1240,6 +1372,10 @@ rename(oldPath: string, newPath: string): Promise&lt;void&gt; ...@@ -1240,6 +1372,10 @@ rename(oldPath: string, newPath: string): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1268,6 +1404,10 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -1268,6 +1404,10 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback&lt;void&gt;): v
| newPath | string | 是 | 文件的应用沙箱新路径。 | | newPath | string | 是 | 文件的应用沙箱新路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步重命名文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步重命名文件之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1297,6 +1437,10 @@ renameSync(oldPath: string, newPath: string): void ...@@ -1297,6 +1437,10 @@ renameSync(oldPath: string, newPath: string): void
| oldPath | string | 是 | 文件的应用沙箱原路径。 | | oldPath | string | 是 | 文件的应用沙箱原路径。 |
| newPath | string | 是 | 文件的应用沙箱新路径。 | | newPath | string | 是 | 文件的应用沙箱新路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1305,7 +1449,6 @@ renameSync(oldPath: string, newPath: string): void ...@@ -1305,7 +1449,6 @@ renameSync(oldPath: string, newPath: string): void
fs.renameSync(srcFile, dstFile); fs.renameSync(srcFile, dstFile);
``` ```
## fs.fsync ## fs.fsync
fsync(fd: number): Promise&lt;void&gt; fsync(fd: number): Promise&lt;void&gt;
...@@ -1326,6 +1469,10 @@ fsync(fd: number): Promise&lt;void&gt; ...@@ -1326,6 +1469,10 @@ fsync(fd: number): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1338,7 +1485,6 @@ fsync(fd: number): Promise&lt;void&gt; ...@@ -1338,7 +1485,6 @@ fsync(fd: number): Promise&lt;void&gt;
}); });
``` ```
## fs.fsync ## fs.fsync
fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void
...@@ -1354,6 +1500,10 @@ fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1354,6 +1500,10 @@ fsync(fd: number, callback: AsyncCallback&lt;void&gt;): void
| fd | number | 是 | 已打开的文件描述符。 | | fd | number | 是 | 已打开的文件描述符。 |
| Callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件数据同步之后的回调。 | | Callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件数据同步之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1384,6 +1534,10 @@ fsyncSync(fd: number): void ...@@ -1384,6 +1534,10 @@ fsyncSync(fd: number): void
| ---- | ------ | ---- | ------------ | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 已打开的文件描述符。 | | fd | number | 是 | 已打开的文件描述符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1393,7 +1547,6 @@ fsyncSync(fd: number): void ...@@ -1393,7 +1547,6 @@ fsyncSync(fd: number): void
fs.closeSync(file); fs.closeSync(file);
``` ```
## fs.fdatasync ## fs.fdatasync
fdatasync(fd: number): Promise&lt;void&gt; fdatasync(fd: number): Promise&lt;void&gt;
...@@ -1414,6 +1567,10 @@ fdatasync(fd: number): Promise&lt;void&gt; ...@@ -1414,6 +1567,10 @@ fdatasync(fd: number): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1427,7 +1584,6 @@ fdatasync(fd: number): Promise&lt;void&gt; ...@@ -1427,7 +1584,6 @@ fdatasync(fd: number): Promise&lt;void&gt;
}); });
``` ```
## fs.fdatasync ## fs.fdatasync
fdatasync(fd: number, callback: AsyncCallback&lt;void&gt;): void fdatasync(fd: number, callback: AsyncCallback&lt;void&gt;): void
...@@ -1443,6 +1599,10 @@ fdatasync(fd: number, callback: AsyncCallback&lt;void&gt;): void ...@@ -1443,6 +1599,10 @@ fdatasync(fd: number, callback: AsyncCallback&lt;void&gt;): void
| fd | number | 是 | 已打开的文件描述符。 | | fd | number | 是 | 已打开的文件描述符。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件内容数据同步之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步将文件内容数据同步之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1472,6 +1632,10 @@ fdatasyncSync(fd: number): void ...@@ -1472,6 +1632,10 @@ fdatasyncSync(fd: number): void
| ---- | ------ | ---- | ------------ | | ---- | ------ | ---- | ------------ |
| fd | number | 是 | 已打开的文件描述符。 | | fd | number | 是 | 已打开的文件描述符。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1481,7 +1645,6 @@ fdatasyncSync(fd: number): void ...@@ -1481,7 +1645,6 @@ fdatasyncSync(fd: number): void
fs.closeSync(file); fs.closeSync(file);
``` ```
## fs.symlink ## fs.symlink
symlink(target: string, srcPath: string): Promise&lt;void&gt; symlink(target: string, srcPath: string): Promise&lt;void&gt;
...@@ -1503,6 +1666,10 @@ symlink(target: string, srcPath: string): Promise&lt;void&gt; ...@@ -1503,6 +1666,10 @@ symlink(target: string, srcPath: string): Promise&lt;void&gt;
| ------------------- | ---------------------------- | | ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1531,6 +1698,10 @@ symlink(target: string, srcPath: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -1531,6 +1698,10 @@ symlink(target: string, srcPath: string, callback: AsyncCallback&lt;void&gt;): v
| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | | srcPath | string | 是 | 符号链接文件的应用沙箱路径。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步创建符号链接信息之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步创建符号链接信息之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1560,6 +1731,10 @@ symlinkSync(target: string, srcPath: string): void ...@@ -1560,6 +1731,10 @@ symlinkSync(target: string, srcPath: string): void
| target | string | 是 | 源文件的应用沙箱路径。 | | target | string | 是 | 源文件的应用沙箱路径。 |
| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | | srcPath | string | 是 | 符号链接文件的应用沙箱路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1573,7 +1748,7 @@ listFile(path: string, options?: { ...@@ -1573,7 +1748,7 @@ listFile(path: string, options?: {
recursion?: boolean; recursion?: boolean;
listNum?: number; listNum?: number;
filter?: Filter; filter?: Filter;
}): Promise<string[]>; }): Promise<string[]>
列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Promise异步回调。 列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Promise异步回调。
...@@ -1600,6 +1775,10 @@ listFile(path: string, options?: { ...@@ -1600,6 +1775,10 @@ listFile(path: string, options?: {
| --------------------- | ---------- | | --------------------- | ---------- |
| Promise&lt;string[]&gt; | Promise对象。返回文件名数组。 | | Promise&lt;string[]&gt; | Promise对象。返回文件名数组。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1628,7 +1807,7 @@ listFile(path: string, options?: { ...@@ -1628,7 +1807,7 @@ listFile(path: string, options?: {
recursion?: boolean; recursion?: boolean;
listNum?: number; listNum?: number;
filter?: Filter; filter?: Filter;
}, callback: AsyncCallback<string[]>): void; }, callback: AsyncCallback<string[]>): void
列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Callback异步回调。 列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤，使用Callback异步回调。
...@@ -1648,6 +1827,10 @@ listFile(path: string, options?: { ...@@ -1648,6 +1827,10 @@ listFile(path: string, options?: {
| listNum | number | 否 | 列出文件名数量。当设置0时，列出所有文件，默认为0。 | | listNum | number | 否 | 列出文件名数量。当设置0时，列出所有文件，默认为0。 |
| filter | [Filter](#filter) | 否 | 文件过滤选项。当前仅支持后缀名匹配、文件名模糊查询、文件大小过滤、最近修改时间过滤。 | | filter | [Filter](#filter) | 否 | 文件过滤选项。当前仅支持后缀名匹配、文件名模糊查询、文件大小过滤、最近修改时间过滤。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1679,7 +1862,7 @@ listFileSync(path: string, options?: { ...@@ -1679,7 +1862,7 @@ listFileSync(path: string, options?: {
recursion?: boolean; recursion?: boolean;
listNum?: number; listNum?: number;
filter?: Filter; filter?: Filter;
}): string[]; }): string[]
以同步方式列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤。 以同步方式列出文件夹下所有文件名，支持递归列出所有文件名（包含子目录下），支持文件过滤。
...@@ -1704,6 +1887,10 @@ listFileSync(path: string, options?: { ...@@ -1704,6 +1887,10 @@ listFileSync(path: string, options?: {
| --------------------- | ---------- | | --------------------- | ---------- |
| string[] | 返回文件名数组。 | | string[] | 返回文件名数组。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1723,9 +1910,10 @@ listFileSync(path: string, options?: { ...@@ -1723,9 +1910,10 @@ listFileSync(path: string, options?: {
console.info("filename: %s", filenames[i]); console.info("filename: %s", filenames[i]);
} }
``` ```
## fs.moveFile ## fs.moveFile
moveFile(src: string, dest: string, mode?: number): Promise\<void>; moveFile(src: string, dest: string, mode?: number): Promise\<void>
移动文件，使用Promise异步回调。 移动文件，使用Promise异步回调。
...@@ -1739,6 +1927,16 @@ moveFile(src: string, dest: string, mode?: number): Promise\<void>; ...@@ -1739,6 +1927,16 @@ moveFile(src: string, dest: string, mode?: number): Promise\<void>;
| dest | string | 是 | 目的文件的应用沙箱路径。 | | dest | string | 是 | 目的文件的应用沙箱路径。 |
| mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 | | mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 |
**返回值：**
| 类型 | 说明 |
| ------------------- | ---------------------------- |
| Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1753,7 +1951,7 @@ moveFile(src: string, dest: string, mode?: number): Promise\<void>; ...@@ -1753,7 +1951,7 @@ moveFile(src: string, dest: string, mode?: number): Promise\<void>;
## fs.moveFile ## fs.moveFile
moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void>): void; moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void>): void
移动文件，使用Callback异步回调。 移动文件，使用Callback异步回调。
...@@ -1768,6 +1966,10 @@ moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void ...@@ -1768,6 +1966,10 @@ moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void
| mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 | | mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步移动文件之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步移动文件之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1784,7 +1986,7 @@ moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void ...@@ -1784,7 +1986,7 @@ moveFile(src: string, dest: string, mode?: number, callback: AsyncCallback\<void
## fs.moveFileSync ## fs.moveFileSync
moveFile(src: string, dest: string, mode?: number): void; moveFile(src: string, dest: string, mode?: number): void
以同步方式移动文件。 以同步方式移动文件。
...@@ -1798,6 +2000,10 @@ moveFile(src: string, dest: string, mode?: number): void; ...@@ -1798,6 +2000,10 @@ moveFile(src: string, dest: string, mode?: number): void;
| dest | string | 是 | 目的文件的应用沙箱路径。 | | dest | string | 是 | 目的文件的应用沙箱路径。 |
| mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 | | mode | number | 否 | 移动模式。若mode为0，移动位置存在同名文件时，强制移动覆盖。若mode为1，移动位置存在同名文件时，抛出异常。默认为0。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1827,6 +2033,10 @@ mkdtemp(prefix: string): Promise&lt;string&gt; ...@@ -1827,6 +2033,10 @@ mkdtemp(prefix: string): Promise&lt;string&gt;
| --------------------- | ---------- | | --------------------- | ---------- |
| Promise&lt;string&gt; | Promise对象。返回生成的唯一目录路径。 | | Promise&lt;string&gt; | Promise对象。返回生成的唯一目录路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1837,7 +2047,6 @@ mkdtemp(prefix: string): Promise&lt;string&gt; ...@@ -1837,7 +2047,6 @@ mkdtemp(prefix: string): Promise&lt;string&gt;
}); });
``` ```
## fs.mkdtemp ## fs.mkdtemp
mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void
...@@ -1853,6 +2062,10 @@ mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void ...@@ -1853,6 +2062,10 @@ mkdtemp(prefix: string, callback: AsyncCallback&lt;string&gt;): void
| prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 | | prefix | string | 是 | 用随机产生的字符串替换以“XXXXXX”结尾目录路径。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步创建临时目录之后的回调。 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步创建临时目录之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1885,6 +2098,10 @@ mkdtempSync(prefix: string): string ...@@ -1885,6 +2098,10 @@ mkdtempSync(prefix: string): string
| ------ | ---------- | | ------ | ---------- |
| string | 产生的唯一目录路径。 | | string | 产生的唯一目录路径。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1912,6 +2129,10 @@ createStream(path: string, mode: string): Promise&lt;Stream&gt; ...@@ -1912,6 +2129,10 @@ createStream(path: string, mode: string): Promise&lt;Stream&gt;
| --------------------------------- | --------- | | --------------------------------- | --------- |
| Promise&lt;[Stream](#stream)&gt; | Promise对象。返回文件流的结果。 | | Promise&lt;[Stream](#stream)&gt; | Promise对象。返回文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1940,6 +2161,10 @@ createStream(path: string, mode: string, callback: AsyncCallback&lt;Stream&gt;): ...@@ -1940,6 +2161,10 @@ createStream(path: string, mode: string, callback: AsyncCallback&lt;Stream&gt;):
| mode | string | 是 | -&nbsp;r：打开只读文件，该文件必须存在。<br/>-&nbsp;r+：打开可读写的文件，该文件必须存在。<br/>-&nbsp;w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。<br/>-&nbsp;a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r：打开只读文件，该文件必须存在。<br/>-&nbsp;r+：打开可读写的文件，该文件必须存在。<br/>-&nbsp;w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。<br/>-&nbsp;a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback&lt;[Stream](#stream)&gt; | 是 | 异步打开文件流之后的回调。 | | callback | AsyncCallback&lt;[Stream](#stream)&gt; | 是 | 异步打开文件流之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -1974,6 +2199,10 @@ createStreamSync(path: string, mode: string): Stream ...@@ -1974,6 +2199,10 @@ createStreamSync(path: string, mode: string): Stream
| ------------------ | --------- | | ------------------ | --------- |
| [Stream](#stream) | 返回文件流的结果。 | | [Stream](#stream) | 返回文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2003,6 +2232,10 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt; ...@@ -2003,6 +2232,10 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt;
| --------------------------------- | --------- | | --------------------------------- | --------- |
| Promise&lt;[Stream](#stream)&gt; | Promise对象。返回文件流的结果。 | | Promise&lt;[Stream](#stream)&gt; | Promise对象。返回文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2016,7 +2249,6 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt; ...@@ -2016,7 +2249,6 @@ fdopenStream(fd: number, mode: string): Promise&lt;Stream&gt;
}); });
``` ```
## fs.fdopenStream ## fs.fdopenStream
fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): void fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): void
...@@ -2033,6 +2265,10 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): v ...@@ -2033,6 +2265,10 @@ fdopenStream(fd: number, mode: string, callback: AsyncCallback&lt;Stream&gt;): v
| mode | string | 是 | -&nbsp;r：打开只读文件，该文件必须存在。<br/>-&nbsp;r+：打开可读写的文件，该文件必须存在。<br/>-&nbsp;w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。<br/>-&nbsp;a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | | mode | string | 是 | -&nbsp;r：打开只读文件，该文件必须存在。<br/>-&nbsp;r+：打开可读写的文件，该文件必须存在。<br/>-&nbsp;w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。<br/>-&nbsp;a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。<br/>-&nbsp;a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 |
| callback | AsyncCallback&lt;[Stream](#stream)&gt; | 是 | 异步打开文件流之后的回调。 | | callback | AsyncCallback&lt;[Stream](#stream)&gt; | 是 | 异步打开文件流之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2069,6 +2305,10 @@ fdopenStreamSync(fd: number, mode: string): Stream ...@@ -2069,6 +2305,10 @@ fdopenStreamSync(fd: number, mode: string): Stream
| ------------------ | --------- | | ------------------ | --------- |
| [Stream](#stream) | 返回文件流的结果。 | | [Stream](#stream) | 返回文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2082,7 +2322,7 @@ fdopenStreamSync(fd: number, mode: string): Stream ...@@ -2082,7 +2322,7 @@ fdopenStreamSync(fd: number, mode: string): Stream
文件具体信息，在调用Stat的方法前，需要先通过[stat()](#fsstat)方法（同步或异步）来构建一个Stat实例。 文件具体信息，在调用Stat的方法前，需要先通过[stat()](#fsstat)方法（同步或异步）来构建一个Stat实例。
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.File.FileIO。 **系统能力**：SystemCapability.FileManagement.File.FileIO
### 属性 ### 属性
...@@ -2097,7 +2337,6 @@ fdopenStreamSync(fd: number, mode: string): Stream ...@@ -2097,7 +2337,6 @@ fdopenStreamSync(fd: number, mode: string): Stream
| mtime | number | 是 | 否 | 上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。 | | mtime | number | 是 | 否 | 上次修改该文件的时间，表示距1970年1月1日0时0分0秒的秒数。 |
| ctime | number | 是 | 否 | 最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。 | | ctime | number | 是 | 否 | 最近改变文件状态的时间，表示距1970年1月1日0时0分0秒的秒数。 |
### isBlockDevice ### isBlockDevice
isBlockDevice(): boolean isBlockDevice(): boolean
...@@ -2112,6 +2351,10 @@ isBlockDevice(): boolean ...@@ -2112,6 +2351,10 @@ isBlockDevice(): boolean
| ------- | ---------------- | | ------- | ---------------- |
| boolean | 表示文件是否是块特殊设备。 | | boolean | 表示文件是否是块特殊设备。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2133,6 +2376,10 @@ isCharacterDevice(): boolean ...@@ -2133,6 +2376,10 @@ isCharacterDevice(): boolean
| ------- | ----------------- | | ------- | ----------------- |
| boolean | 表示文件是否是字符特殊设备。 | | boolean | 表示文件是否是字符特殊设备。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2140,7 +2387,6 @@ isCharacterDevice(): boolean ...@@ -2140,7 +2387,6 @@ isCharacterDevice(): boolean
let isCharacterDevice = fs.statSync(filePath).isCharacterDevice(); let isCharacterDevice = fs.statSync(filePath).isCharacterDevice();
``` ```
### isDirectory ### isDirectory
isDirectory(): boolean isDirectory(): boolean
...@@ -2155,6 +2401,10 @@ isDirectory(): boolean ...@@ -2155,6 +2401,10 @@ isDirectory(): boolean
| ------- | ------------- | | ------- | ------------- |
| boolean | 表示文件是否是目录。 | | boolean | 表示文件是否是目录。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2162,7 +2412,6 @@ isDirectory(): boolean ...@@ -2162,7 +2412,6 @@ isDirectory(): boolean
let isDirectory = fs.statSync(dirPath).isDirectory(); let isDirectory = fs.statSync(dirPath).isDirectory();
``` ```
### isFIFO ### isFIFO
isFIFO(): boolean isFIFO(): boolean
...@@ -2177,6 +2426,10 @@ isFIFO(): boolean ...@@ -2177,6 +2426,10 @@ isFIFO(): boolean
| ------- | --------------------- | | ------- | --------------------- |
| boolean | 表示文件是否是&nbsp;FIFO。 | | boolean | 表示文件是否是&nbsp;FIFO。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2184,7 +2437,6 @@ isFIFO(): boolean ...@@ -2184,7 +2437,6 @@ isFIFO(): boolean
let isFIFO = fs.statSync(filePath).isFIFO(); let isFIFO = fs.statSync(filePath).isFIFO();
``` ```
### isFile ### isFile
isFile(): boolean isFile(): boolean
...@@ -2199,6 +2451,10 @@ isFile(): boolean ...@@ -2199,6 +2451,10 @@ isFile(): boolean
| ------- | --------------- | | ------- | --------------- |
| boolean | 表示文件是否是普通文件。 | | boolean | 表示文件是否是普通文件。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2206,7 +2462,6 @@ isFile(): boolean ...@@ -2206,7 +2462,6 @@ isFile(): boolean
let isFile = fs.statSync(filePath).isFile(); let isFile = fs.statSync(filePath).isFile();
``` ```
### isSocket ### isSocket
isSocket(): boolean isSocket(): boolean
...@@ -2221,6 +2476,10 @@ isSocket(): boolean ...@@ -2221,6 +2476,10 @@ isSocket(): boolean
| ------- | -------------- | | ------- | -------------- |
| boolean | 表示文件是否是套接字。 | | boolean | 表示文件是否是套接字。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2228,7 +2487,6 @@ isSocket(): boolean ...@@ -2228,7 +2487,6 @@ isSocket(): boolean
let isSocket = fs.statSync(filePath).isSocket(); let isSocket = fs.statSync(filePath).isSocket();
``` ```
### isSymbolicLink ### isSymbolicLink
isSymbolicLink(): boolean isSymbolicLink(): boolean
...@@ -2243,6 +2501,10 @@ isSymbolicLink(): boolean ...@@ -2243,6 +2501,10 @@ isSymbolicLink(): boolean
| ------- | --------------- | | ------- | --------------- |
| boolean | 表示文件是否是符号链接。 | | boolean | 表示文件是否是符号链接。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2254,7 +2516,6 @@ isSymbolicLink(): boolean ...@@ -2254,7 +2516,6 @@ isSymbolicLink(): boolean
文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。 文件流，在调用Stream的方法前，需要先通过createStream()方法（同步或异步）来构建一个Stream实例。
### close ### close
close(): Promise&lt;void&gt; close(): Promise&lt;void&gt;
...@@ -2269,6 +2530,10 @@ close(): Promise&lt;void&gt; ...@@ -2269,6 +2530,10 @@ close(): Promise&lt;void&gt;
| ------------------- | ------------- | | ------------------- | ------------- |
| Promise&lt;void&gt; | Promise对象。返回表示异步关闭文件流的结果。 | | Promise&lt;void&gt; | Promise对象。返回表示异步关闭文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2281,7 +2546,6 @@ close(): Promise&lt;void&gt; ...@@ -2281,7 +2546,6 @@ close(): Promise&lt;void&gt;
}); });
``` ```
### close ### close
close(callback: AsyncCallback&lt;void&gt;): void close(callback: AsyncCallback&lt;void&gt;): void
...@@ -2296,6 +2560,10 @@ close(callback: AsyncCallback&lt;void&gt;): void ...@@ -2296,6 +2560,10 @@ close(callback: AsyncCallback&lt;void&gt;): void
| -------- | ------------------------- | ---- | ------------- | | -------- | ------------------------- | ---- | ------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步关闭文件流之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2318,6 +2586,10 @@ closeSync(): void ...@@ -2318,6 +2586,10 @@ closeSync(): void
**系统能力**：SystemCapability.FileManagement.File.FileIO **系统能力**：SystemCapability.FileManagement.File.FileIO
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2340,6 +2612,10 @@ flush(): Promise&lt;void&gt; ...@@ -2340,6 +2612,10 @@ flush(): Promise&lt;void&gt;
| ------------------- | ------------- | | ------------------- | ------------- |
| Promise&lt;void&gt; | Promise对象。返回表示异步刷新文件流的结果。 | | Promise&lt;void&gt; | Promise对象。返回表示异步刷新文件流的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2352,7 +2628,6 @@ flush(): Promise&lt;void&gt; ...@@ -2352,7 +2628,6 @@ flush(): Promise&lt;void&gt;
}); });
``` ```
### flush ### flush
flush(callback: AsyncCallback&lt;void&gt;): void flush(callback: AsyncCallback&lt;void&gt;): void
...@@ -2367,6 +2642,10 @@ flush(callback: AsyncCallback&lt;void&gt;): void ...@@ -2367,6 +2642,10 @@ flush(callback: AsyncCallback&lt;void&gt;): void
| -------- | ------------------------- | ---- | -------------- | | -------- | ------------------------- | ---- | -------------- |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步刷新文件流后的回调函数。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步刷新文件流后的回调函数。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2389,6 +2668,10 @@ flushSync(): void ...@@ -2389,6 +2668,10 @@ flushSync(): void
**系统能力**：SystemCapability.FileManagement.File.FileIO **系统能力**：SystemCapability.FileManagement.File.FileIO
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2418,6 +2701,10 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; ...@@ -2418,6 +2701,10 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number;
| --------------------- | -------- | | --------------------- | -------- |
| Promise&lt;number&gt; | Promise对象。返回实际写入的长度。 | | Promise&lt;number&gt; | Promise对象。返回实际写入的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2430,7 +2717,6 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; ...@@ -2430,7 +2717,6 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number;
}); });
``` ```
### write ### write
write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;number&gt;): void write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; encoding?: string; }, callback: AsyncCallback&lt;number&gt;): void
...@@ -2447,6 +2733,10 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number; ...@@ -2447,6 +2733,10 @@ write(buffer: ArrayBuffer|string, options?: { offset?: number; length?: number;
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;offset，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。<br/>-&nbsp;encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。| | options | Object | 否 | 支持如下选项：<br/>-&nbsp;length，number类型，表示期望写入数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;offset，number类型，表示期望写入文件的位置。可选，默认从当前位置开始写。<br/>-&nbsp;encoding，string类型，当数据是string类型时有效，表示数据的编码方式，默认&nbsp;'utf-8'。仅支持&nbsp;'utf-8'。|
| callback | AsyncCallback&lt;number&gt; | 是 | 异步写入完成后执行的回调函数。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步写入完成后执行的回调函数。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2484,6 +2774,10 @@ writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: numb ...@@ -2484,6 +2774,10 @@ writeSync(buffer: ArrayBuffer|string, options?: { offset?: number; length?: numb
| ------ | -------- | | ------ | -------- |
| number | 实际写入的长度。 | | number | 实际写入的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2513,6 +2807,10 @@ read(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Prom ...@@ -2513,6 +2807,10 @@ read(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Prom
| ---------------------------------- | ------ | | ---------------------------------- | ------ |
| Promise&lt;number&gt; | Promise对象。返回读取的结果。 | | Promise&lt;number&gt; | Promise对象。返回读取的结果。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2527,7 +2825,6 @@ read(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Prom ...@@ -2527,7 +2825,6 @@ read(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): Prom
}); });
``` ```
### read ### read
read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback&lt;number&gt;): void read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length?: number; }, callback: AsyncCallback&lt;number&gt;): void
...@@ -2544,6 +2841,10 @@ read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length ...@@ -2544,6 +2841,10 @@ read(buffer: ArrayBuffer, options?: { position?: number; offset?: number; length
| options | Object | 否 | 支持如下选项：<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读. | | options | Object | 否 | 支持如下选项：<br/>-&nbsp;length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度。<br/>-&nbsp;offset，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读. |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步从流文件读取数据之后的回调。 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步从流文件读取数据之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2581,6 +2882,10 @@ readSync(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): ...@@ -2581,6 +2882,10 @@ readSync(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }):
| ------ | -------- | | ------ | -------- |
| number | 实际读取的长度。 | | number | 实际读取的长度。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2603,7 +2908,7 @@ readSync(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }): ...@@ -2603,7 +2908,7 @@ readSync(buffer: ArrayBuffer, options?: { offset?: number; length?: number; }):
### lock ### lock
lock(exclusive?: boolean): Promise\<void>; lock(exclusive?: boolean): Promise\<void>
文件阻塞式施加共享锁或独占锁，使用Promise异步回调。 文件阻塞式施加共享锁或独占锁，使用Promise异步回调。
...@@ -2621,6 +2926,10 @@ lock(exclusive?: boolean): Promise\<void>; ...@@ -2621,6 +2926,10 @@ lock(exclusive?: boolean): Promise\<void>;
| ---------------------------------- | ------ | | ---------------------------------- | ------ |
| Promise&lt;void&gt; | Promise对象。无返回值。 | | Promise&lt;void&gt; | Promise对象。无返回值。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2634,7 +2943,7 @@ lock(exclusive?: boolean): Promise\<void>; ...@@ -2634,7 +2943,7 @@ lock(exclusive?: boolean): Promise\<void>;
### lock ### lock
lock(exclusive?: boolean, callback: AsyncCallback\<void>): void; lock(exclusive?: boolean, callback: AsyncCallback\<void>): void
文件阻塞式施加共享锁或独占锁，使Callback异步回调。 文件阻塞式施加共享锁或独占锁，使Callback异步回调。
...@@ -2647,6 +2956,10 @@ lock(exclusive?: boolean, callback: AsyncCallback\<void>): void; ...@@ -2647,6 +2956,10 @@ lock(exclusive?: boolean, callback: AsyncCallback\<void>): void;
| exclusive | boolean | 否 | 是否施加独占锁，默认false。 | | exclusive | boolean | 否 | 是否施加独占锁，默认false。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 异步文件上锁之后的回调。 | | callback | AsyncCallback&lt;void&gt; | 是 | 异步文件上锁之后的回调。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2662,7 +2975,7 @@ lock(exclusive?: boolean, callback: AsyncCallback\<void>): void; ...@@ -2662,7 +2975,7 @@ lock(exclusive?: boolean, callback: AsyncCallback\<void>): void;
### tryLock ### tryLock
tryLock(exclusive?: boolean): void; tryLock(exclusive?: boolean): void
文件非阻塞式施加共享锁或独占锁。 文件非阻塞式施加共享锁或独占锁。
...@@ -2674,6 +2987,10 @@ tryLock(exclusive?: boolean): void; ...@@ -2674,6 +2987,10 @@ tryLock(exclusive?: boolean): void;
| ------- | ----------- | ---- | ---------------------------------------- | | ------- | ----------- | ---- | ---------------------------------------- |
| exclusive | boolean | 否 | 是否施加独占锁，默认false。 | | exclusive | boolean | 否 | 是否施加独占锁，默认false。 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -2684,12 +3001,16 @@ tryLock(exclusive?: boolean): void; ...@@ -2684,12 +3001,16 @@ tryLock(exclusive?: boolean): void;
### unlock ### unlock
unlock(): void; unlock(): void
以同步方式给文件解锁。 以同步方式给文件解锁。
**系统能力**：SystemCapability.FileManagement.File.FileIO **系统能力**：SystemCapability.FileManagement.File.FileIO
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
......
zh-cn/application-dev/reference/apis/js-apis-file-hash.md
浏览文件 @ 7831ae63
...@@ -3,8 +3,8 @@ ...@@ -3,8 +3,8 @@
该模块提供文件哈希处理能力，对文件内容进行哈希处理。 该模块提供文件哈希处理能力，对文件内容进行哈希处理。
> **说明：** > **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
...@@ -63,6 +63,15 @@ hash(path: string, algorithm: string): Promise&lt;string&gt; ...@@ -63,6 +63,15 @@ hash(path: string, algorithm: string): Promise&lt;string&gt;
| --------------------- | -------------------------- | | --------------------- | -------------------------- |
| Promise&lt;string&gt; | Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。 | | Promise&lt;string&gt; | Promise对象。返回文件的哈希值。表示为十六进制数字串，所有字母均大写。 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：** **示例：**
```js ```js
...@@ -90,7 +99,17 @@ hash(path: string, algorithm: string, callback: AsyncCallback&lt;string&gt;): vo ...@@ -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"。 | | algorithm | string | 是 | 哈希计算采用的算法。可选&nbsp;"md5"、"sha1"&nbsp;或&nbsp;"sha256"。建议采用安全强度更高的&nbsp;"sha256"。 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步计算文件哈希操作之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 | | callback | AsyncCallback&lt;string&gt; | 是 | 异步计算文件哈希操作之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 |
**错误码：**
以下错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 13900020 | Invalid argument |
| 13900042 | Unknown error |
**示例：** **示例：**
```js ```js
let filePath = pathDir + "/test.txt"; let filePath = pathDir + "/test.txt";
Hash.hash(filePath, "sha256", (err, str) => { Hash.hash(filePath, "sha256", (err, str) => {
......
zh-cn/application-dev/reference/apis/js-apis-file-picker.md
浏览文件 @ 7831ae63
...@@ -6,6 +6,7 @@ ...@@ -6,6 +6,7 @@
选择器(Picker)是一个封装PhotoViewPicker、DocumentViewPicker、AudioViewPicker等系统应用选择与保存能力的模块。应用可以自行选择使用哪种picker实现文件选择和文件保存的功能。 选择器(Picker)是一个封装PhotoViewPicker、DocumentViewPicker、AudioViewPicker等系统应用选择与保存能力的模块。应用可以自行选择使用哪种picker实现文件选择和文件保存的功能。
## 导入模块 ## 导入模块
```js ```js
import picker from '@ohos.file.picker'; import picker from '@ohos.file.picker';
``` ```
...@@ -30,7 +31,7 @@ select(option?: PhotoSelectOptions) : Promise&lt;PhotoSelectResult&gt; ...@@ -30,7 +31,7 @@ select(option?: PhotoSelectOptions) : Promise&lt;PhotoSelectResult&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -70,7 +71,7 @@ select(option: PhotoSelectOptions, callback: AsyncCallback&lt;PhotoSelectResult& ...@@ -70,7 +71,7 @@ select(option: PhotoSelectOptions, callback: AsyncCallback&lt;PhotoSelectResult&
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -107,7 +108,7 @@ select(callback: AsyncCallback&lt;PhotoSelectResult&gt;) : void ...@@ -107,7 +108,7 @@ select(callback: AsyncCallback&lt;PhotoSelectResult&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -140,7 +141,7 @@ save(option?: PhotoSaveOptions) : Promise&lt;Array&lt;string&gt;&gt; ...@@ -140,7 +141,7 @@ save(option?: PhotoSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -179,7 +180,7 @@ save(option: PhotoSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt ...@@ -179,7 +180,7 @@ save(option: PhotoSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -215,7 +216,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void ...@@ -215,7 +216,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -260,7 +261,7 @@ select(option?: DocumentSelectOptions) : Promise&lt;Array&lt;string&gt;&gt; ...@@ -260,7 +261,7 @@ select(option?: DocumentSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -298,7 +299,7 @@ select(option: DocumentSelectOptions, callback: AsyncCallback&lt;Array&lt;string ...@@ -298,7 +299,7 @@ select(option: DocumentSelectOptions, callback: AsyncCallback&lt;Array&lt;string
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -333,7 +334,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void ...@@ -333,7 +334,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -367,7 +368,7 @@ save(option?: DocumentSaveOptions) : Promise&lt;Array&lt;string&gt;&gt; ...@@ -367,7 +368,7 @@ save(option?: DocumentSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -406,7 +407,7 @@ save(option: DocumentSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt; ...@@ -406,7 +407,7 @@ save(option: DocumentSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -442,7 +443,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void ...@@ -442,7 +443,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -487,7 +488,7 @@ select(option?: AudioSelectOptions) : Promise&lt;Array&lt;string&gt;&gt; ...@@ -487,7 +488,7 @@ select(option?: AudioSelectOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -525,7 +526,7 @@ select(option: AudioSelectOptions, callback: AsyncCallback&lt;Array&lt;string&gt ...@@ -525,7 +526,7 @@ select(option: AudioSelectOptions, callback: AsyncCallback&lt;Array&lt;string&gt
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -560,7 +561,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void ...@@ -560,7 +561,7 @@ select(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -593,7 +594,7 @@ save(option?: AudioSaveOptions) : Promise&lt;Array&lt;string&gt;&gt; ...@@ -593,7 +594,7 @@ save(option?: AudioSaveOptions) : Promise&lt;Array&lt;string&gt;&gt;
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -632,7 +633,7 @@ save(option: AudioSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt ...@@ -632,7 +633,7 @@ save(option: AudioSaveOptions, callback: AsyncCallback&lt;Array&lt;string&gt;&gt
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -668,7 +669,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void ...@@ -668,7 +669,7 @@ save(callback: AsyncCallback&lt;Array&lt;string&gt;&gt;) : void
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
......
zh-cn/application-dev/reference/apis/js-apis-file-securityLabel.md
浏览文件 @ 7831ae63
...@@ -3,8 +3,8 @@ ...@@ -3,8 +3,8 @@
该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。 该模块提供文件数据安全等级的相关功能：向应用程序提供查询、设置文件数据安全等级的JS接口。
> **说明：** > **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
...@@ -63,6 +63,21 @@ setSecurityLabel(path:string, type:DataLevel):Promise&lt;void&gt; ...@@ -63,6 +63,21 @@ setSecurityLabel(path:string, type:DataLevel):Promise&lt;void&gt;
| ------------------- | ---------------- | | ------------------- | ---------------- |
| Promise&lt;void&gt; | Promise实例，用于异步获取结果。本调用将返回空值。| | 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 ```js
...@@ -90,6 +105,21 @@ setSecurityLabel(path:string, type:DataLevel, callback: AsyncCallback&lt;void&gt ...@@ -90,6 +105,21 @@ setSecurityLabel(path:string, type:DataLevel, callback: AsyncCallback&lt;void&gt
| type | DataLevel | 是 | 文件等级属性，只支持"s0","s1","s2","s3","s4" | | type | DataLevel | 是 | 文件等级属性，只支持"s0","s1","s2","s3","s4" |
| callback | AsyncCallback&lt;void&gt; | 是 | 是否设置数据标签之后的回调 | | 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 ```js
...@@ -118,6 +148,21 @@ setSecurityLabelSync(path:string, type:DataLevel):void ...@@ -118,6 +148,21 @@ setSecurityLabelSync(path:string, type:DataLevel):void
| path | string | 是 | 文件路径 | | path | string | 是 | 文件路径 |
| type | DataLevel | 是 | 文件等级属性，只支持"s0","s1","s2","s3","s4" | | 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 ```js
...@@ -145,6 +190,21 @@ getSecurityLabel(path:string):Promise&lt;string&gt; ...@@ -145,6 +190,21 @@ getSecurityLabel(path:string):Promise&lt;string&gt;
| --------------------- | ------------ | | --------------------- | ------------ |
| 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 ```js
...@@ -171,6 +231,21 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void ...@@ -171,6 +231,21 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
| path | string | 是 | 文件路径 | | path | string | 是 | 文件路径 |
| callback | AsyncCallback&lt;string&gt; | 是 | 异步获取数据标签之后的回调 | | 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 ```js
...@@ -183,6 +258,7 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void ...@@ -183,6 +258,7 @@ getSecurityLabel(path:string, callback:AsyncCallback&lt;string&gt;): void
} }
}); });
``` ```
## securityLabel.getSecurityLabelSync ## securityLabel.getSecurityLabelSync
getSecurityLabelSync(path:string):string getSecurityLabelSync(path:string):string
...@@ -203,6 +279,21 @@ getSecurityLabelSync(path:string):string ...@@ -203,6 +279,21 @@ getSecurityLabelSync(path:string):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 ```js
......
zh-cn/application-dev/reference/apis/js-apis-file-statvfs.md
浏览文件 @ 7831ae63
...@@ -3,14 +3,15 @@ ...@@ -3,14 +3,15 @@
该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。 该模块提供文件系统相关存储信息的功能，向应用程序提供获取文件系统总字节数、空闲字节数的JS接口。
> **说明：** > **说明：**
>
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
```js ```js
import statvfs from '@ohos.file.statvfs'; import statvfs from '@ohos.file.statvfs';
``` ```
## statvfs.getFreeSize ## statvfs.getFreeSize
getFreeSize(path:string):Promise&lt;number&gt; getFreeSize(path:string):Promise&lt;number&gt;
...@@ -31,6 +32,10 @@ getFreeSize(path:string):Promise&lt;number&gt; ...@@ -31,6 +32,10 @@ getFreeSize(path:string):Promise&lt;number&gt;
| --------------------- | -------------- | | --------------------- | -------------- |
| Promise&lt;number&gt; | 返回空闲字节数 | | Promise&lt;number&gt; | 返回空闲字节数 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -57,6 +62,10 @@ getFreeSize(path:string, callback:AsyncCallback&lt;number&gt;): void ...@@ -57,6 +62,10 @@ getFreeSize(path:string, callback:AsyncCallback&lt;number&gt;): void
| path | string | 是 | 需要查询的文件系统的文件路径 | | path | string | 是 | 需要查询的文件系统的文件路径 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步获取空闲字节数之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步获取空闲字节数之后的回调 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -90,6 +99,10 @@ getTotalSize(path: string): Promise&lt;number&gt; ...@@ -90,6 +99,10 @@ getTotalSize(path: string): Promise&lt;number&gt;
| --------------------- | ------------ | | --------------------- | ------------ |
| Promise&lt;number&gt; | 返回总字节数 | | Promise&lt;number&gt; | 返回总字节数 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -116,6 +129,10 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -116,6 +129,10 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void
| path | string | 是 | 需要查询的文件系统的文件路径 | | path | string | 是 | 需要查询的文件系统的文件路径 |
| callback | AsyncCallback&lt;number&gt; | 是 | 异步获取总字节数之后的回调 | | callback | AsyncCallback&lt;number&gt; | 是 | 异步获取总字节数之后的回调 |
**错误码：**
接口抛出错误码的详细介绍请参见[基础文件IO错误码](../errorcodes/errorcode-filemanagement.md#基础文件io错误码)。
**示例：** **示例：**
```js ```js
...@@ -128,4 +145,3 @@ getTotalSize(path: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -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
浏览文件 @ 7831ae63
...@@ -4,8 +4,8 @@ ...@@ -4,8 +4,8 @@
> **说明：** > **说明：**
> >
> - 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
```js ```js
...@@ -24,7 +24,6 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt; ...@@ -24,7 +24,6 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -37,6 +36,19 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt; ...@@ -37,6 +36,19 @@ getTotalSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回指定卷设备的总空间大小（单位为Byte） | | 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 ```js
...@@ -60,7 +72,6 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -60,7 +72,6 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -68,6 +79,19 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -68,6 +79,19 @@ getTotalSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| volumeUuid | string | 是 | 卷设备uuid | | volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷设备总空间之后的回调 | | 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 ```js
...@@ -90,7 +114,6 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt; ...@@ -90,7 +114,6 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -103,6 +126,19 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt; ...@@ -103,6 +126,19 @@ getFreeSizeOfVolume(volumeUuid: string): Promise&lt;number&gt;
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回指定卷的可用空间大小（单位为Byte） | | 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 ```js
...@@ -127,7 +163,6 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -127,7 +163,6 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -135,6 +170,19 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;): ...@@ -135,6 +170,19 @@ getFreeSizeOfVolume(volumeUuid: string, callback: AsyncCallback&lt;number&gt;):
| volumeUuid | string | 是 | 卷设备uuid | | volumeUuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取指定卷可用空间之后的回调 | | 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 ```js
...@@ -157,7 +205,6 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt; ...@@ -157,7 +205,6 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -170,6 +217,19 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt; ...@@ -170,6 +217,19 @@ getBundleStats(packageName: string): Promise&lt;BundleStats&gt;
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存储数据（单位为Byte） | | 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 ```js
...@@ -193,7 +253,6 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;) ...@@ -193,7 +253,6 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -201,6 +260,19 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;) ...@@ -201,6 +260,19 @@ getBundleStats(packageName: string, callback: AsyncCallback&lt;BundleStats&gt;)
| packageName | string | 是 | 应用包名 | | packageName | string | 是 | 应用包名 |
| callback | AsyncCallback&lt;[Bundlestats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储数据之后的回调 | | 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 ```js
...@@ -225,6 +297,16 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt; ...@@ -225,6 +297,16 @@ getCurrentBundleStats(): Promise&lt;BundleStats&gt;
| ------------------------------------------ | -------------------------- | | ------------------------------------------ | -------------------------- |
| Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存空间大小（单位为Byte） | | Promise&lt;[Bundlestats](#bundlestats9)&gt; | 返回指定卷上的应用存空间大小（单位为Byte） |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：** **示例：**
```js ```js
...@@ -246,6 +328,16 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void ...@@ -246,6 +328,16 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| -------- | --------------------------------------------------------- | ---- | ------------------------------------ | | -------- | --------------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[BundleStats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储空间大小之后的回调 | | callback | AsyncCallback&lt;[BundleStats](#bundlestats9)&gt; | 是 | 获取指定卷上的应用存储空间大小之后的回调 |
**错误码：**
以下错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
| 错误码ID | 错误信息 |
| -------- | -------- |
| 401 | The input parameter is invalid. |
| 13600001 | IPC error. |
| 13900032 | Unknown error. |
**示例：** **示例：**
```js ```js
...@@ -257,7 +349,7 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void ...@@ -257,7 +349,7 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
## BundleStats<sup>9+</sup> ## BundleStats<sup>9+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics **系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | ------ | --- | ---- | -------------- | | --------- | ------ | --- | ---- | -------------- |
...@@ -265,7 +357,6 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void ...@@ -265,7 +357,6 @@ getCurrentBundleStats(callback: AsyncCallback&lt;BundleStats&gt;): void
| cacheSize | number | 是 | 否 | 缓存数据大小（单位为Byte） | | cacheSize | number | 是 | 否 | 缓存数据大小（单位为Byte） |
| dataSize | number | 是 | 否 | 应用总数据大小（单位为Byte） | | dataSize | number | 是 | 否 | 应用总数据大小（单位为Byte） |
## storageStatistics.getTotalSize<sup>9+</sup> ## storageStatistics.getTotalSize<sup>9+</sup>
getTotalSize(): Promise&lt;number&gt; getTotalSize(): Promise&lt;number&gt;
...@@ -284,6 +375,18 @@ getTotalSize(): Promise&lt;number&gt; ...@@ -284,6 +375,18 @@ getTotalSize(): Promise&lt;number&gt;
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的总空间大小（单位为Byte） | | 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 ```js
...@@ -309,6 +412,18 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -309,6 +412,18 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
| -------- | ------------------------------------ | ---- | ------------------------ | | -------- | ------------------------------------ | ---- | ------------------------ |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的总空间大小之后的回调 | | 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 ```js
...@@ -318,7 +433,6 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -318,7 +433,6 @@ getTotalSize(callback: AsyncCallback&lt;number&gt;): void
}); });
``` ```
## storageStatistics.getFreeSize<sup>9+</sup> ## storageStatistics.getFreeSize<sup>9+</sup>
getFreeSize(): Promise&lt;number&gt; getFreeSize(): Promise&lt;number&gt;
...@@ -337,6 +451,18 @@ getFreeSize(): Promise&lt;number&gt; ...@@ -337,6 +451,18 @@ getFreeSize(): Promise&lt;number&gt;
| --------------------- | ------------------ | | --------------------- | ------------------ |
| Promise&lt;number&gt; | 返回内置存储的可用空间大小（单位为Byte） | | 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 ```js
...@@ -344,7 +470,6 @@ getFreeSize(): Promise&lt;number&gt; ...@@ -344,7 +470,6 @@ getFreeSize(): Promise&lt;number&gt;
console.info("getFreeSize successfully:"+ JSON.stringify(number)); console.info("getFreeSize successfully:"+ JSON.stringify(number));
``` ```
## storageStatistics.getFreeSize<sup>9+</sup> ## storageStatistics.getFreeSize<sup>9+</sup>
getFreeSize(callback: AsyncCallback&lt;number&gt;): void getFreeSize(callback: AsyncCallback&lt;number&gt;): void
...@@ -363,6 +488,18 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -363,6 +488,18 @@ getFreeSize(callback: AsyncCallback&lt;number&gt;): void
| -------- | ------------------------------------ | ---- | ------------------------- | | -------- | ------------------------------------ | ---- | ------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取内置存储的可用空间大小之后的回调 | | 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 ```js
...@@ -384,13 +521,24 @@ getSystemSize(): Promise&lt;number&gt; ...@@ -384,13 +521,24 @@ getSystemSize(): Promise&lt;number&gt;
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;number&gt; | 返回系统数据的空间大小（单位为Byte） | | 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 ```js
...@@ -419,6 +567,18 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void ...@@ -419,6 +567,18 @@ getSystemSize(callback: AsyncCallback&lt;number&gt;): void
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;number&gt; | 是 | 获取系统数据的空间大小之后的回调 | | 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 ```js
...@@ -446,6 +606,18 @@ getUserStorageStats(): Promise&lt;StorageStats&gt; ...@@ -446,6 +606,18 @@ getUserStorageStats(): Promise&lt;StorageStats&gt;
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回当前用户各类别存储空间大小（单位为Byte） | | 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 ```js
...@@ -474,6 +646,18 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void ...@@ -474,6 +646,18 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void
| ---------- | ------------------------------------ | ---- | -------------------------- | | ---------- | ------------------------------------ | ---- | -------------------------- |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回用户各类别存储空间大小之后的回调 | | 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 ```js
...@@ -482,6 +666,7 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void ...@@ -482,6 +666,7 @@ getUserStorageStats(callback: AsyncCallback&lt;StorageStats&gt;): void
console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats)); console.info("getUserStorageStats successfully:"+ JSON.stringify(StorageStats));
}); });
``` ```
getUserStorageStats(userId: number): Promise&lt;StorageStats&gt; getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
异步获取指定用户各类别存储空间大小（单位为Byte），以promise方式返回。 异步获取指定用户各类别存储空间大小（单位为Byte），以promise方式返回。
...@@ -504,6 +689,19 @@ getUserStorageStats(userId: number): Promise&lt;StorageStats&gt; ...@@ -504,6 +689,19 @@ getUserStorageStats(userId: number): Promise&lt;StorageStats&gt;
| --------------------- | ---------------- | | --------------------- | ---------------- |
| Promise&lt;[StorageStats](#storagestats9)&gt; | 返回指定用户各类别存储空间大小（单位为Byte） | | 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 ```js
...@@ -534,6 +732,19 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;) ...@@ -534,6 +732,19 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;)
| userId | number | 是 | 用户id | | userId | number | 是 | 用户id |
| callback | AsyncCallback&lt;[StorageStats](#storagestats9)&gt; | 是 | 返回各类别数据大小之后的回调 | | 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 ```js
...@@ -544,10 +755,9 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;) ...@@ -544,10 +755,9 @@ getUserStorageStats(userId: number, callback: AsyncCallback&lt;StorageStats&gt;)
}); });
``` ```
## StorageStats<sup>9+</sup> ## StorageStats<sup>9+</sup>
**系统能力**：以下各项对应的系统能力均为SystemCapability.FileManagement.StorageService.SpatialStatistics **系统能力**：SystemCapability.FileManagement.StorageService.SpatialStatistics
**系统接口：** 该接口为系统接口。 **系统接口：** 该接口为系统接口。
......
zh-cn/application-dev/reference/apis/js-apis-file-volumemanager.md
浏览文件 @ 7831ae63
...@@ -6,7 +6,6 @@ ...@@ -6,7 +6,6 @@
> >
> - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。 > - 本模块接口为系统接口。
> - 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
...@@ -30,6 +29,18 @@ getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt; ...@@ -30,6 +29,18 @@ getAllVolumes(): Promise&lt;Array&lt;Volume&gt;&gt;
| ---------------------------------- | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#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. |
| 13900032 | Unknown error. |
**示例：** **示例：**
```js ```js
...@@ -56,6 +67,18 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void ...@@ -56,6 +67,18 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
| -------- | ------------------------------------------------- | ---- | ------------------------------------ | | -------- | ------------------------------------------------- | ---- | ------------------------------------ |
| callback | AsyncCallback&lt;[Volume](#volume)[]&gt; | 是 | 获取当前所有可获得的卷设备信息之后的回调 | | 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 ```js
...@@ -65,7 +88,6 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void ...@@ -65,7 +88,6 @@ getAllVolumes(callback: AsyncCallback&lt;Array&lt;Volume&gt;&gt;): void
}); });
``` ```
## volumemanager.mount ## volumemanager.mount
mount(volumeId: string): Promise&lt;void&gt; mount(volumeId: string): Promise&lt;void&gt;
...@@ -88,6 +110,22 @@ mount(volumeId: string): Promise&lt;void&gt; ...@@ -88,6 +110,22 @@ mount(volumeId: string): Promise&lt;void&gt;
| ---------------------- | ---------- | | ---------------------- | ---------- |
| 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 ```js
...@@ -116,6 +154,22 @@ mount(volumeId: string, callback:AsyncCallback&lt;void&gt;):void ...@@ -116,6 +154,22 @@ mount(volumeId: string, callback:AsyncCallback&lt;void&gt;):void
| volumeId | string | 是 | 卷设备id | | volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;void&gt; | 是 | 挂载指定卷设备之后的回调 | | 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 ```js
...@@ -147,6 +201,22 @@ unmount(volumeId: string): Promise&lt;void&gt; ...@@ -147,6 +201,22 @@ unmount(volumeId: string): Promise&lt;void&gt;
| ---------------------- | ---------- | | ---------------------- | ---------- |
| 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 ```js
...@@ -175,6 +245,22 @@ unmount(volumeId: string, callback: AsyncCallback&lt;void&gt;): void ...@@ -175,6 +245,22 @@ unmount(volumeId: string, callback: AsyncCallback&lt;void&gt;): void
| volumeId | string | 是 | 卷设备id | | volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;void&gt; | 是 | 卸载指定卷设备之后的回调 | | 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 ```js
...@@ -206,6 +292,19 @@ getVolumeByUuid(uuid: string): Promise&lt;Volume&gt; ...@@ -206,6 +292,19 @@ getVolumeByUuid(uuid: string): Promise&lt;Volume&gt;
| ---------------------------------- | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#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 ```js
...@@ -234,6 +333,19 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void ...@@ -234,6 +333,19 @@ getVolumeByUuid(uuid: string, callback: AsyncCallback&lt;Volume&gt;): void
| uuid | string | 是 | 卷设备uuid | | uuid | string | 是 | 卷设备uuid |
| callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷设备信息之后的回调 | | 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 ```js
...@@ -265,6 +377,19 @@ getVolumeById(volumeId: string): Promise&lt;Volume&gt; ...@@ -265,6 +377,19 @@ getVolumeById(volumeId: string): Promise&lt;Volume&gt;
| ---------------------------------- | -------------------------- | | ---------------------------------- | -------------------------- |
| Promise&lt;[Volume](#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 ```js
...@@ -293,6 +418,19 @@ getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void ...@@ -293,6 +418,19 @@ getVolumeById(volumeId: string, callback: AsyncCallback&lt;Volume&gt;): void
| volumeId | string | 是 | 卷设备id | | volumeId | string | 是 | 卷设备id |
| callback | AsyncCallback&lt;[Volume](#volume)&gt; | 是 | 获取卷设备信息之后的回调 | | 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 ```js
...@@ -325,6 +463,21 @@ setVolumeDescription(uuid: string, description: string): Promise&lt;void&gt; ...@@ -325,6 +463,21 @@ setVolumeDescription(uuid: string, description: string): Promise&lt;void&gt;
| ---------------------- | -------------------------- | | ---------------------- | -------------------------- |
| 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 ```js
...@@ -355,6 +508,21 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback& ...@@ -355,6 +508,21 @@ setVolumeDescription(uuid: string, description: string, callback: AsyncCallback&
| description | string | 是 | 卷设备描述 | | description | string | 是 | 卷设备描述 |
| callback | AsyncCallback&lt;void&gt; | 是 | 设置卷描述之后的回调 | | 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 ```js
...@@ -388,6 +556,21 @@ format(volumeId: string, fsType: string): Promise&lt;void&gt; ...@@ -388,6 +556,21 @@ format(volumeId: string, fsType: string): Promise&lt;void&gt;
| ---------------------- | ---------- | | ---------------------- | ---------- |
| 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 ```js
...@@ -418,6 +601,21 @@ format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): v ...@@ -418,6 +601,21 @@ format(volumeId: string, fsType: string, callback: AsyncCallback&lt;void&gt;): v
| fsType | string | 是 | 文件系统类型(vfat或者exfat) | | fsType | string | 是 | 文件系统类型(vfat或者exfat) |
| callback | AsyncCallback&lt;void&gt; | 是 | 对指定卷设备格式化后的回调 | | 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 ```js
...@@ -451,6 +649,19 @@ partition(diskId: string, type: number): Promise&lt;void&gt; ...@@ -451,6 +649,19 @@ partition(diskId: string, type: number): Promise&lt;void&gt;
| --------------------- | ----------------------- | | --------------------- | ----------------------- |
| 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 ```js
...@@ -481,6 +692,19 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo ...@@ -481,6 +692,19 @@ partition(diskId: string, type: number, callback: AsyncCallback&lt;void&gt;): vo
| type | number | 是 | 分区类型 | | type | number | 是 | 分区类型 |
| callback | AsyncCallback&lt;void&gt; | 是 | 对磁盘设备进行分区 | | 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 ```js
......
zh-cn/application-dev/reference/apis/js-apis-fileAccess.md
浏览文件 @ 7831ae63
...@@ -4,9 +4,8 @@ fileAccess模块是基于extension机制实现的一个对公共文件访问和 ...@@ -4,9 +4,8 @@ fileAccess模块是基于extension机制实现的一个对公共文件访问和
>**说明：** >**说明：**
> >
>- 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
>- 本模块接口为系统接口，三方应用不支持调用，当前只支持filepicker、文件管理器调用。 > - 本模块接口为系统接口，三方应用不支持调用，当前只支持FilePicker、文件管理器调用。
>- 本模块支持对错误码进行处理，错误码及其适配方式[参考文档](../errorcodes/errorcode-filemanagement.md#错误码适配指导)。
## 导入模块 ## 导入模块
...@@ -16,10 +15,12 @@ import fileAccess from '@ohos.file.fileAccess'; ...@@ -16,10 +15,12 @@ import fileAccess from '@ohos.file.fileAccess';
## fileAccess.getFileAccessAbilityInfo ## fileAccess.getFileAccessAbilityInfo
getFileAccessAbilityInfo( ) : Promise&lt;Array&lt;Want&gt;&gt; getFileAccessAbilityInfo() : Promise&lt;Array&lt;Want&gt;&gt;
以异步方法获取系统内extension配置为fileAccess类型的所有Want信息。使用Promise异步回调。 以异步方法获取系统内extension配置为fileAccess类型的所有Want信息。使用Promise异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
...@@ -28,7 +29,11 @@ getFileAccessAbilityInfo( ) : Promise&lt;Array&lt;Want&gt;&gt; ...@@ -28,7 +29,11 @@ getFileAccessAbilityInfo( ) : Promise&lt;Array&lt;Want&gt;&gt;
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| Promise&lt;Array&lt;Want&gt;&gt; | 表示当前系统配置fileAccess的所有文件管理类服务 | | Promise&lt;Array&lt;[Want](js-apis-app-ability-want.md)&gt;&gt; | 表示当前系统配置fileAccess的所有文件管理类服务 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -46,10 +51,12 @@ getFileAccessAbilityInfo( ) : Promise&lt;Array&lt;Want&gt;&gt; ...@@ -46,10 +51,12 @@ getFileAccessAbilityInfo( ) : Promise&lt;Array&lt;Want&gt;&gt;
## fileAccess.getFileAccessAbilityInfo ## fileAccess.getFileAccessAbilityInfo
getFileAccessAbilityInfo(callback: AsyncCallback&lt;Array&lt;Want&gt;&gt;): void; getFileAccessAbilityInfo(callback: AsyncCallback&lt;Array&lt;Want&gt;&gt;): void
以异步方法获取系统内extension配置为fileAccess类型的所有Want信息。使用callback异步回调。 以异步方法获取系统内extension配置为fileAccess类型的所有Want信息。使用callback异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
...@@ -58,7 +65,11 @@ getFileAccessAbilityInfo(callback: AsyncCallback&lt;Array&lt;Want&gt;&gt;): void ...@@ -58,7 +65,11 @@ getFileAccessAbilityInfo(callback: AsyncCallback&lt;Array&lt;Want&gt;&gt;): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| callback | AsyncCallback&lt;Array&lt;Want&gt;&gt; | 是 | 表示当前系统配置fileAccess的所有文件管理类服务 | | callback | AsyncCallback&lt;Array&lt;[Want](js-apis-app-ability-want.md)&gt;&gt; | 是 | 表示当前系统配置fileAccess的所有文件管理类服务 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -84,6 +95,8 @@ createFileAccessHelper(context: Context, wants: Array&lt;Want&gt;) : FileAccessH ...@@ -84,6 +95,8 @@ createFileAccessHelper(context: Context, wants: Array&lt;Want&gt;) : FileAccessH
以同步方法创建连接指定wants的helper对象。 以同步方法创建连接指定wants的helper对象。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
...@@ -92,14 +105,18 @@ createFileAccessHelper(context: Context, wants: Array&lt;Want&gt;) : FileAccessH ...@@ -92,14 +105,18 @@ createFileAccessHelper(context: Context, wants: Array&lt;Want&gt;) : FileAccessH
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| context | Context | 是 | 代表ability的上下文的能力 | | context | [Context](js-apis-inner-application-context.md) | 是 | 代表ability的上下文的能力 |
| wants | Array&lt;Want&gt; | 是 | Want是一种基本通信组件，主要用于服务拉起 | | wants | Array&lt;[Want](js-apis-app-ability-want.md)&gt; | 是 | Want是一种基本通信组件，主要用于服务拉起 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileAccessHelper | 提供文件访问和操作能力的helper对象 | | [FileAccessHelper](#fileaccesshelper) | 提供文件访问和操作能力的helper对象 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -131,6 +148,8 @@ createFileAccessHelper(context: Context) : FileAccessHelper ...@@ -131,6 +148,8 @@ createFileAccessHelper(context: Context) : FileAccessHelper
以同步方法创建连接当前系统内所有文件管理服务的helper对象。 以同步方法创建连接当前系统内所有文件管理服务的helper对象。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED **需要权限**：ohos.permission.FILE_ACCESS_MANAGER 和 ohos.permission.GET_BUNDLE_INFO_PRIVILEGED
...@@ -139,13 +158,17 @@ createFileAccessHelper(context: Context) : FileAccessHelper ...@@ -139,13 +158,17 @@ createFileAccessHelper(context: Context) : FileAccessHelper
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| context | Context | 是 | ability的上下文的能力 | | context | [Context](js-apis-inner-application-context.md) | 是 | ability的上下文的能力 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileAccessHelper | 提供文件访问和操作的能力的helper对象 | | [FileAccessHelper](#fileaccesshelper) | 提供文件访问和操作的能力的helper对象 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -164,99 +187,34 @@ createFileAccessHelper(context: Context) : FileAccessHelper ...@@ -164,99 +187,34 @@ createFileAccessHelper(context: Context) : FileAccessHelper
} }
``` ```
## FileAccessHelper.getRoots ## FileInfo
getRoots( ) : Promise&lt;RootIterator&gt;
以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用Promise异步回调。
该方法返回迭代器对象RootIterator，然后通过[next](#rootiteratornext)方法返回[RootInfo](#rootinfo)。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| Promise&lt;RootIterator&gt; | 根设备目录信息组成迭代器对象 |
**示例：**
```js
async getRoots() {
let rootIterator = null;
let rootinfos = [];
let isDone = false;
try {
// fileAccessHelper 参考 fileAccess.createFileAccessHelper 示例代码获取
rootIterator = await fileAccessHelper.getRoots();
if (!rootIterator) {
console.error("getRoots interface returns an undefined object");
return;
}
while (!isDone) {
let result = rootIterator.next();
console.log("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
rootinfos.push(result.value);
}
} catch (error) {
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
```
## FileAccessHelper.getRoots
getRoots(callback:AsyncCallback&lt;RootIterator&gt;) : void; 表示文件(夹)属性信息和接口能力。
以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用callback异步回调。 **模型约束**：此接口仅可在Stage模型下使用。
callback带回迭代器对象RootIterator，然后通过[next](#rootiteratornext)方法返回[RootInfo](#rootinfo)。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** ### 属性
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| callback | AsyncCallback&lt;RootIterator&gt; | 是 | 根设备目录信息组成迭代器对象 |
**示例：**
```js | 名称 | 类型 | 可读 | 可写 | 说明 |
async getRoots() { | ------ | ------ | -------- | ------ | -------- |
let rootinfos = []; | uri | string | 是 | 否 | 文件(夹)的uri |
let isDone = false; | fileName | string | 是 | 否 | 文件(夹)的名称 |
try { | mode | number | 是 | 否 | 文件(夹)的权限信息 |
// fileAccessHelper 参考 fileAccess.createFileAccessHelper 示例代码获取 | size | number | 是 | 否 | 文件(夹)的大小 |
fileAccessHelper.getRoots(function (err, rootIterator) { | mtime | number | 是 | 否 | 文件(夹)的修改时间 |
if (err) { | mimeType | string | 是 | 否 | 文件(夹)的媒体资源类型 |
console.error("Failed to getRoots in async, errCode:" + err.code + ", errMessage:" + err.message);
return;
}
while (!isDone) {
let result = rootIterator.next();
console.log("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
rootinfos.push(result.value);
}
});
} catch (error) {
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
```
## RootInfo.listfile ### listFile
listFile(filter?: Filter) : FileIterator listFile(filter?: Filter) : FileIterator
以同步方法从某设备根节点开始，基于过滤器，获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。 以同步方法从某个目录，基于过滤器，获取下一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
...@@ -266,25 +224,28 @@ listFile(filter?: Filter) : FileIterator ...@@ -266,25 +224,28 @@ listFile(filter?: Filter) : FileIterator
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | -- | -- | | --- | --- | -- | -- |
| filter | Filter | 否 | 过滤器对象 | | filter | [Filter](js-apis-file-fs.md#filter) | 否 | 过滤器对象 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileIterator | 文件(夹)信息的迭代器对象FileIterator | | [FileIterator](#fileiterator) | 文件(夹)信息的迭代器对象FileIterator |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
// rootinfos 从getRoots()获取 // fileInfoDir 表示某个目录信息
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // let filter = { suffix : [".txt", ".jpg", ".xlsx"] };
let rootInfo = rootinfos[0]; let fileInfoDir = fileInfos[0];
let fileInfos = []; let subfileInfos = [];
let isDone = false; let isDone = false;
try { try {
let fileIterator = rootInfo.listFile(); let fileIterator = fileInfoDir.listFile();
// 含过滤器实现的listFile // 含过滤器实现的listFile
// let fileIterator = rootInfo.listFile(filter); // let fileIterator = rootInfo.listFile(filter);
if (!fileIterator) { if (!fileIterator) {
...@@ -296,18 +257,20 @@ listFile(filter?: Filter) : FileIterator ...@@ -296,18 +257,20 @@ listFile(filter?: Filter) : FileIterator
console.log("next result = " + JSON.stringify(result)); console.log("next result = " + JSON.stringify(result));
isDone = result.done; isDone = result.done;
if (!isDone) if (!isDone)
fileInfos.push(result.value); subfileInfos.push(result.value);
} }
} catch (error) { } catch (error) {
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
``` ```
## RootInfo.scanFile ### scanFile
scanFile(filter?: Filter) : FileIterator scanFile(filter?: Filter) : FileIterator
以同步方法从某设备根节点开始，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。 以同步方法从某个目录，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
...@@ -317,28 +280,32 @@ scanFile(filter?: Filter) : FileIterator ...@@ -317,28 +280,32 @@ scanFile(filter?: Filter) : FileIterator
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | -- | -- | | --- | --- | -- | -- |
| filter | Filter | 否 | 过滤器对象 | | filter | [Filter](js-apis-file-fs.md#filter) | 否 | 过滤器对象 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileIterator | 文件信息的迭代器对象FileIterator | | [FileIterator](#fileiterator) | 文件信息的迭代器对象FileIterator |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
// rootInfos 从 getRoots()获取 // fileInfoDir 表示某个目录信息
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let rootInfo = rootInfos[0]; let fileInfoDir = fileInfos[0];
let fileInfos = []; let subfileInfos = [];
let isDone = false; let isDone = false;
try { try {
let fileIterator = rootInfo.scanFile(); let fileIterator = fileInfoDir.scanFile();
// 含过滤器实现的scanFile // 含过滤器实现的scanFile
// let fileIterator = rootInfo.scanFile(filter); // let fileIterator = rootInfo.scanFile(filter);
if (!fileIterator) { if (!fileIterator) {
console.error("scanFile interface returns undefined object"); console.error("scanFile interface returns an undefined object");
return; return;
} }
while (!isDone) { while (!isDone) {
...@@ -346,18 +313,71 @@ scanFile(filter?: Filter) : FileIterator ...@@ -346,18 +313,71 @@ scanFile(filter?: Filter) : FileIterator
console.log("next result = " + JSON.stringify(result)); console.log("next result = " + JSON.stringify(result));
isDone = result.done; isDone = result.done;
if (!isDone) if (!isDone)
fileInfos.push(result.value); subfileInfos.push(result.value);
} }
} catch (error) { } catch (error) {
console.error("scanFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("scanFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
``` ```
## FileInfo.listfile ## FileIterator
表示文件夹的迭代器对象。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### next
next() : { value: FileInfo, done: boolean }
可以通过next同步方法获取下一级文件(夹)信息。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| {value: [FileInfo](#fileinfo), done: boolean} | 通过next遍历文件夹，直到done返回true结束；value字段返回fileInfo。|
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
## RootInfo
表示设备的根属性信息和接口能力。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | -------- | ------ | -------- |
| deviceType | number | 是 | 否 |设备类型 |
| uri | string | 是 | 否 | 设备根目录Uri |
| displayName | string | 是 | 否 | 设备名称 |
| deviceFlags | number | 是 | 否 | 设备支持的能力 |
### listFile
listFile(filter?: Filter) : FileIterator listFile(filter?: Filter) : FileIterator
以同步方法从某个目录，基于过滤器，获取下一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。 以同步方法从某设备根节点开始，基于过滤器，获取第一级符合条件的文件(夹)信息的迭代器对象FileIterator，然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备过滤，外置存储设备不支持过滤。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
...@@ -367,24 +387,28 @@ listFile(filter?: Filter) : FileIterator ...@@ -367,24 +387,28 @@ listFile(filter?: Filter) : FileIterator
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | -- | -- | | --- | --- | -- | -- |
| filter | Filter | 否 | 过滤器对象 | | filter | [Filter](js-apis-file-fs.md#filter) | 否 | 过滤器对象 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileIterator | 文件(夹)信息的迭代器对象FileIterator | | [FileIterator](#fileiterator) | 文件(夹)信息的迭代器对象FileIterator |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
// fileInfoDir 表示某个目录信息 // rootinfos 从getRoots()获取
// let filter = { suffix : [".txt", ".jpg", ".xlsx"] }; // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let fileInfoDir = fileInfos[0]; let rootInfo = rootinfos[0];
let subfileInfos = []; let fileInfos = [];
let isDone = false; let isDone = false;
try { try {
let fileIterator = fileInfoDir.listFile(); let fileIterator = rootInfo.listFile();
// 含过滤器实现的listFile // 含过滤器实现的listFile
// let fileIterator = rootInfo.listFile(filter); // let fileIterator = rootInfo.listFile(filter);
if (!fileIterator) { if (!fileIterator) {
...@@ -396,18 +420,20 @@ listFile(filter?: Filter) : FileIterator ...@@ -396,18 +420,20 @@ listFile(filter?: Filter) : FileIterator
console.log("next result = " + JSON.stringify(result)); console.log("next result = " + JSON.stringify(result));
isDone = result.done; isDone = result.done;
if (!isDone) if (!isDone)
subfileInfos.push(result.value); fileInfos.push(result.value);
} }
} catch (error) { } catch (error) {
console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("listFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
``` ```
## FileInfo.scanfile ### scanFile
scanFile(filter?: Filter) : FileIterator; scanFile(filter?: Filter) : FileIterator
以同步方法从某设备根节点开始，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过[next](#next)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。
以同步方法从某个目录，基于过滤器，递归获取符合条件的文件信息的迭代器对象FileIterator，然后通过[next](#fileiteratornext)方法返回[FileInfo](#fileinfo)。目前仅支持内置存储设备。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
...@@ -417,29 +443,32 @@ scanFile(filter?: Filter) : FileIterator; ...@@ -417,29 +443,32 @@ scanFile(filter?: Filter) : FileIterator;
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | -- | -- | | --- | --- | -- | -- |
| filter | Filter | 否 | 过滤器对象 | | filter | [Filter](js-apis-file-fs.md#filter) | 否 | 过滤器对象 |
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --- | -- | | --- | -- |
| FileIterator | 文件信息的迭代器对象FileIterator | | [FileIterator](#fileiterator) | 文件信息的迭代器对象FileIterator |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
// fileInfoDir 表示某个目录信息 // rootInfos 从 getRoots()获取
// let filter = {suffix : [".txt", ".jpg", ".xlsx"]}; // let filter = {suffix : [".txt", ".jpg", ".xlsx"]};
let fileInfoDir = fileInfos[0]; let rootInfo = rootInfos[0];
let subfileInfos = []; let fileInfos = [];
let isDone = false; let isDone = false;
try { try {
let fileIterator = fileInfoDir.scanFile(); let fileIterator = rootInfo.scanFile();
// 含过滤器实现的scanFile // 含过滤器实现的scanFile
// let fileIterator = rootInfo.scanFile(filter); // let fileIterator = rootInfo.scanFile(filter);
if (!fileIterator) { if (!fileIterator) {
console.error("scanFile interface returns an undefined object"); console.error("scanFile interface returns undefined object");
return; return;
} }
while (!isDone) { while (!isDone) {
...@@ -447,29 +476,173 @@ scanFile(filter?: Filter) : FileIterator; ...@@ -447,29 +476,173 @@ scanFile(filter?: Filter) : FileIterator;
console.log("next result = " + JSON.stringify(result)); console.log("next result = " + JSON.stringify(result));
isDone = result.done; isDone = result.done;
if (!isDone) if (!isDone)
subfileInfos.push(result.value); fileInfos.push(result.value);
} }
} catch (error) { } catch (error) {
console.error("scanFile failed, errCode:" + error.code + ", errMessage:" + error.message); console.error("scanFile failed, errCode:" + error.code + ", errMessage:" + error.message);
} }
``` ```
## FileAccessHelper.createFile ## RootIterator
表示设备根目录的迭代器对象。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### next
next() : { value: RootInfo, done: boolean }
通过next同步方法获取下一级设备根目录。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| {value: [RootInfo](#rootinfo), done: boolean} | 通过next遍历文件夹，直到done返回true结束；value字段返回rootInfo。|
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
## FileAccessHelper
FileAccessHelper对象。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### getRoots
getRoots() : Promise&lt;RootIterator&gt;
以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用Promise异步回调。
该方法返回迭代器对象RootIterator，然后通过[next](#next-1)方法返回[RootInfo](#rootinfo)。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| Promise&lt;[RootIterator](#rootiterator)&gt; | 根设备目录信息组成迭代器对象 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：**
```js
async getRoots() {
let rootIterator = null;
let rootinfos = [];
let isDone = false;
try {
// fileAccessHelper 参考 fileAccess.createFileAccessHelper 示例代码获取
rootIterator = await fileAccessHelper.getRoots();
if (!rootIterator) {
console.error("getRoots interface returns an undefined object");
return;
}
while (!isDone) {
let result = rootIterator.next();
console.log("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
rootinfos.push(result.value);
}
} catch (error) {
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
```
### getRoots
getRoots(callback:AsyncCallback&lt;RootIterator&gt;) : void
以异步方法获取helper对象连接的文件管理服务类的设备根节点信息。使用callback异步回调。
callback带回迭代器对象RootIterator，然后通过[next](#next-1)方法返回[RootInfo](#rootinfo)。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- |
| callback | AsyncCallback&lt;[RootIterator](#rootiterator)&gt; | 是 | 根设备目录信息组成迭代器对象 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：**
```js
async getRoots() {
let rootinfos = [];
let isDone = false;
try {
// fileAccessHelper 参考 fileAccess.createFileAccessHelper 示例代码获取
fileAccessHelper.getRoots(function (err, rootIterator) {
if (err) {
console.error("Failed to getRoots in async, errCode:" + err.code + ", errMessage:" + err.message);
return;
}
while (!isDone) {
let result = rootIterator.next();
console.log("next result = " + JSON.stringify(result));
isDone = result.done;
if (!isDone)
rootinfos.push(result.value);
}
});
} catch (error) {
console.error("getRoots failed, errCode:" + error.code + ", errMessage:" + error.message);
}
}
```
### createFile
createFile(uri: string, displayName: string) : Promise&lt;string&gt; createFile(uri: string, displayName: string) : Promise&lt;string&gt;
以异步方法创建文件到指定目录，返回新文件uri。使用Promise异步回调。 以异步方法创建文件到指定目录，返回新文件uri。使用Promise异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 表示需要创建文件的父目录的Uri | | uri | string | 是 | 表示需要创建文件的父目录的Uri |
| displayName | string | 是 | 待创建文件的名称，默认本地文件需要添加后缀 | | displayName | string | 是 | 待创建文件的名称，默认本地文件需要添加后缀 |
**返回值：** **返回值：**
...@@ -477,6 +650,10 @@ createFile(uri: string, displayName: string) : Promise&lt;string&gt; ...@@ -477,6 +650,10 @@ createFile(uri: string, displayName: string) : Promise&lt;string&gt;
| --- | -- | | --- | -- |
| Promise&lt;string&gt; | 新创建的文件的uri | | Promise&lt;string&gt; | 新创建的文件的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -499,23 +676,29 @@ createFile(uri: string, displayName: string) : Promise&lt;string&gt; ...@@ -499,23 +676,29 @@ createFile(uri: string, displayName: string) : Promise&lt;string&gt;
}; };
``` ```
## FileAccessHelper.createFile ### createFile
createFile(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void; createFile(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void
以异步方法创建文件到指定目录，返回新文件uri。使用callback异步回调。 以异步方法创建文件到指定目录，返回新文件uri。使用callback异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 表示需要创建文件的父目录的Uri | | uri | string | 是 | 表示需要创建文件的父目录的Uri |
| displayName | string | 是 | 待创建文件的名称，默认本地文件需要添加后缀 | | displayName | string | 是 | 待创建文件的名称，默认本地文件需要添加后缀 |
| callback | AsyncCallback&lt;string&gt; | 是 | 新创建的文件的uri | | callback | AsyncCallback&lt;string&gt; | 是 | 新创建的文件的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -539,22 +722,24 @@ createFile(uri: string, displayName: string, callback: AsyncCallback&lt;string&g ...@@ -539,22 +722,24 @@ createFile(uri: string, displayName: string, callback: AsyncCallback&lt;string&g
}; };
``` ```
## FileAccessHelper.mkDir ### mkDir
mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt; mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt;
以异步方法创建文件夹到指定目录，返回文件夹uri。使用Promise异步回调。 以异步方法创建文件夹到指定目录，返回文件夹uri。使用Promise异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| parentUri | string | 是 | 表示需要创建文件夹的父目录的Uri | | parentUri | string | 是 | 表示需要创建文件夹的父目录的Uri |
| displayName | string | 是 | 待创建文件夹的名称| | displayName | string | 是 | 待创建文件夹的名称|
**返回值：** **返回值：**
...@@ -562,6 +747,10 @@ mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt; ...@@ -562,6 +747,10 @@ mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt;
| --- | -- | | --- | -- |
| Promise&lt;string&gt; | 新创建的文件夹的uri | | Promise&lt;string&gt; | 新创建的文件夹的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -584,23 +773,29 @@ mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt; ...@@ -584,23 +773,29 @@ mkDir(parentUri: string, displayName: string) : Promise&lt;string&gt;
}; };
``` ```
## FileAccessHelper.mkDir ### mkDir
mkDir(parentUri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void; mkDir(parentUri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void
以异步方法创建文件夹到指定目录，返回文件夹uri。使用callback异步回调。 以异步方法创建文件夹到指定目录，返回文件夹uri。使用callback异步回调。
**模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService **系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| parentUri | string | 是 | 表示需要创建文件夹的父目录的Uri | | parentUri | string | 是 | 表示需要创建文件夹的父目录的Uri |
| displayName | string | 是 | 待创建文件夹的名称| | displayName | string | 是 | 待创建文件夹的名称|
| callback | AsyncCallback&lt;string&gt; | 是 | 新创建的文件夹的uri | | callback | AsyncCallback&lt;string&gt; | 是 | 新创建的文件夹的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -624,22 +819,24 @@ mkDir(parentUri: string, displayName: string, callback: AsyncCallback&lt;string& ...@@ -624,22 +819,24 @@ mkDir(parentUri: string, displayName: string, callback: AsyncCallback&lt;string&
}; };
``` ```
## FileAccessHelper.openFile ### openFile
openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt; openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt;
以异步方法打开文件，返回文件描述符。使用Promise异步回调。 以异步方法打开文件，返回文件描述符。使用Promise异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 待打开文件的uri | | uri | string | 是 | 待打开文件的uri |
| flags | [OPENFLAGS](#openflags) | 是 | 文件打开的标志 | | flags | [OPENFLAGS](#openflags) | 是 | 文件打开的标志 |
**返回值：** **返回值：**
...@@ -647,6 +844,10 @@ openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt; ...@@ -647,6 +844,10 @@ openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt;
| --- | -- | | --- | -- |
| Promise&lt;number&gt; | 文件描述符 | | Promise&lt;number&gt; | 文件描述符 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -662,23 +863,29 @@ openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt; ...@@ -662,23 +863,29 @@ openFile(uri: string, flags: OPENFLAGS) : Promise&lt;number&gt;
}; };
``` ```
## FileAccessHelper.openFile ### openFile
openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback&lt;number&gt;) : void; openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback&lt;number&gt;) : void
以异步方法打开文件，返回文件描述符。使用callback异步回调。 以异步方法打开文件，返回文件描述符。使用callback异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 待打开文件的uri | | uri | string | 是 | 待打开文件的uri |
| flags | [OPENFLAGS](#openflags) | 是 | 文件打开的标志 | | flags | [OPENFLAGS](#openflags) | 是 | 文件打开的标志 |
| callback | AsyncCallback&lt;number&gt; | 是 | 文件描述符 | | callback | AsyncCallback&lt;number&gt; | 是 | 文件描述符 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -701,21 +908,23 @@ openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback&lt;number&gt;) : ...@@ -701,21 +908,23 @@ openFile(uri: string, flags: OPENFLAGS, callback: AsyncCallback&lt;number&gt;) :
}; };
``` ```
## FileAccessHelper.delete ### delete
delete(uri: string) : Promise&lt;number&gt; delete(uri: string) : Promise&lt;number&gt;
以异步方法删除文件(夹)，返回错误码。使用Promise异步回调。 以异步方法删除文件(夹)，返回错误码。使用Promise异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 待删除文件(夹)的uri | | uri | string | 是 | 待删除文件(夹)的uri |
**返回值：** **返回值：**
...@@ -723,6 +932,10 @@ delete(uri: string) : Promise&lt;number&gt; ...@@ -723,6 +932,10 @@ delete(uri: string) : Promise&lt;number&gt;
| --- | -- | | --- | -- |
| Promise&lt;number&gt | 删除操作的错误码 | | Promise&lt;number&gt | 删除操作的错误码 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -740,22 +953,28 @@ delete(uri: string) : Promise&lt;number&gt; ...@@ -740,22 +953,28 @@ delete(uri: string) : Promise&lt;number&gt;
}; };
``` ```
## FileAccessHelper.delete ### delete
delete(uri: string, callback: AsyncCallback&lt;number&gt;) : void; delete(uri: string, callback: AsyncCallback&lt;number&gt;) : void
以异步方法删除文件(夹)，返回错误码。使用callback异步回调。 以异步方法删除文件(夹)，返回错误码。使用callback异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 待删除文件(夹)的uri | | uri | string | 是 | 待删除文件(夹)的uri |
| callback | AsyncCallback&lt;number&gt; | 是 | 删除操作的错误码 | | callback | AsyncCallback&lt;number&gt; | 是 | 删除操作的错误码 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -778,22 +997,24 @@ delete(uri: string, callback: AsyncCallback&lt;number&gt;) : void; ...@@ -778,22 +997,24 @@ delete(uri: string, callback: AsyncCallback&lt;number&gt;) : void;
}; };
``` ```
## FileAccessHelper.move ### move
move(sourceFile: string, destFile: string) : Promise&lt;string&gt; move(sourceFile: string, destFile: string) : Promise&lt;string&gt;
以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用Promise异步回调。目前仅支持设备内移动，跨设备不支持移动。 以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用Promise异步回调。目前仅支持设备内移动，跨设备不支持移动。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| sourceFile | string | 是 | 待移动的源文件(夹)的uri | | sourceFile | string | 是 | 待移动的源文件(夹)的uri |
| destFile | string | 是 | 目标文件夹的uri | | destFile | string | 是 | 目标文件夹的uri |
**返回值：** **返回值：**
...@@ -801,6 +1022,10 @@ move(sourceFile: string, destFile: string) : Promise&lt;string&gt; ...@@ -801,6 +1022,10 @@ move(sourceFile: string, destFile: string) : Promise&lt;string&gt;
| ----- | ------ | | ----- | ------ |
| Promise&lt;string&gt; | 新路径下的文件(夹)的uri | | Promise&lt;string&gt; | 新路径下的文件(夹)的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -818,23 +1043,29 @@ move(sourceFile: string, destFile: string) : Promise&lt;string&gt; ...@@ -818,23 +1043,29 @@ move(sourceFile: string, destFile: string) : Promise&lt;string&gt;
}; };
``` ```
## FileAccessHelper.move ### move
move(sourceFile: string, destFile: string, callback: AsyncCallback&lt;string&gt;) : void; move(sourceFile: string, destFile: string, callback: AsyncCallback&lt;string&gt;) : void
以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用callback异步回调。目前仅支持设备内移动，跨设备不支持移动。 以异步方法移动文件(夹)，返回移动后文件(夹)的uri。使用callback异步回调。目前仅支持设备内移动，跨设备不支持移动。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| sourceFile | string | 是 | 待移动的源文件(夹)的uri | | sourceFile | string | 是 | 待移动的源文件(夹)的uri |
| destFile | string | 是 | 目标文件夹的uri | | destFile | string | 是 | 目标文件夹的uri |
| callback | AsyncCallback&lt;string&gt; | 是 | 新路径下的文件(夹)的uri | | callback | AsyncCallback&lt;string&gt; | 是 | 新路径下的文件(夹)的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -858,22 +1089,24 @@ move(sourceFile: string, destFile: string, callback: AsyncCallback&lt;string&gt; ...@@ -858,22 +1089,24 @@ move(sourceFile: string, destFile: string, callback: AsyncCallback&lt;string&gt;
}; };
``` ```
## FileAccessHelper.rename ### rename
rename(uri: string, displayName: string) : Promise&lt;string&gt; rename(uri: string, displayName: string) : Promise&lt;string&gt;
以异步方法重命名文件(夹)，返回重命名后的文件(夹)的Uri。使用Promise异步回调。 以异步方法重命名文件(夹)，返回重命名后的文件(夹)的Uri。使用Promise异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 源文件(夹)的uri | | uri | string | 是 | 源文件(夹)的uri |
| displayName | string | 是 | 文件(夹)名，支持带后缀 | | displayName | string | 是 | 文件(夹)名，支持带后缀 |
**返回值：** **返回值：**
...@@ -881,6 +1114,10 @@ rename(uri: string, displayName: string) : Promise&lt;string&gt; ...@@ -881,6 +1114,10 @@ rename(uri: string, displayName: string) : Promise&lt;string&gt;
| --- | -- | | --- | -- |
| Promise&lt;string&gt; | 重命名后的文件(夹)的uri | | Promise&lt;string&gt; | 重命名后的文件(夹)的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -897,23 +1134,29 @@ rename(uri: string, displayName: string) : Promise&lt;string&gt; ...@@ -897,23 +1134,29 @@ rename(uri: string, displayName: string) : Promise&lt;string&gt;
}; };
``` ```
## FileAccessHelper.rename ### rename
rename(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void; rename(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) : void
以异步方法重命名文件(夹)，返回重命名后的文件(夹)的Uri。使用callback异步回调。 以异步方法重命名文件(夹)，返回重命名后的文件(夹)的Uri。使用callback异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| uri | string | 是 | 源文件(夹)的uri | | uri | string | 是 | 源文件(夹)的uri |
| displayName | string | 是 | 文件(夹)名，支持带后缀 | | displayName | string | 是 | 文件(夹)名，支持带后缀 |
| callback | AsyncCallback&lt;string&gt; | 是 | 重命名后的文件(夹)的uri | | callback | AsyncCallback&lt;string&gt; | 是 | 重命名后的文件(夹)的uri |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -936,21 +1179,23 @@ rename(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;) ...@@ -936,21 +1179,23 @@ rename(uri: string, displayName: string, callback: AsyncCallback&lt;string&gt;)
}; };
``` ```
## FileAccessHelper.access ### access
access(sourceFileUri: string) : Promise&lt;boolean&gt; access(sourceFileUri: string) : Promise&lt;boolean&gt;
以异步方法判断文件(夹)是否存在。使用Promise异步回调。 以异步方法判断文件(夹)是否存在。使用Promise异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| sourceFileUri | string | 是 | 文件(夹)的uri | | sourceFileUri | string | 是 | 文件(夹)的uri |
**返回值：** **返回值：**
...@@ -958,6 +1203,10 @@ access(sourceFileUri: string) : Promise&lt;boolean&gt; ...@@ -958,6 +1203,10 @@ access(sourceFileUri: string) : Promise&lt;boolean&gt;
| --- | -- | | --- | -- |
| Promise&lt;boolean&gt; | 文件(夹)是否存在 | | Promise&lt;boolean&gt; | 文件(夹)是否存在 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
```js ```js
...@@ -977,22 +1226,28 @@ access(sourceFileUri: string) : Promise&lt;boolean&gt; ...@@ -977,22 +1226,28 @@ access(sourceFileUri: string) : Promise&lt;boolean&gt;
}; };
``` ```
## FileAccessHelper.access ### access
access(sourceFileUri: string, callback: AsyncCallback&lt;boolean&gt;) : void; access(sourceFileUri: string, callback: AsyncCallback&lt;boolean&gt;) : void
以异步方法判断文件(夹)是否存在。使用callback异步回调。 以异步方法判断文件(夹)是否存在。使用callback异步回调。
**系统能力**：SystemCapability.FileManagement.UserFileService。 **模型约束**：此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileService
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER **需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| --- | --- | --- | -- | | --- | --- | --- | -- |
| sourceFileUri | string | 是 | 文件(夹)的uri | | sourceFileUri | string | 是 | 文件(夹)的uri |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 文件(夹)是否存在 | | callback | AsyncCallback&lt;boolean&gt; | 是 | 文件(夹)是否存在 |
**错误码：**
接口抛出错误码的详细介绍请参见[文件管理错误码](../errorcodes/errorcode-filemanagement.md)。
**示例：** **示例：**
...@@ -1018,74 +1273,6 @@ access(sourceFileUri: string, callback: AsyncCallback&lt;boolean&gt;) : void; ...@@ -1018,74 +1273,6 @@ access(sourceFileUri: string, callback: AsyncCallback&lt;boolean&gt;) : void;
}; };
``` ```
## RootIterator.next
next( ) : { value: RootInfo, done: boolean }
RootIterator表示设备根目录的迭代器对象，可以通过next同步方法获取下一级设备根目录。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| {value: RootInfo, done: boolean} | 通过next遍历文件夹，直到done返回true结束；value字段返回rootInfo。|
## FileIterator.next
next( ) : { value: FileInfo, done: boolean }
FileIterator表示文件夹的迭代器对象，可以通过next同步方法获取下一级文件(夹)信息。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
**返回值：**
| 类型 | 说明 |
| --- | -- |
| {value: FileInfo, done: boolean} | 通过next遍历文件夹，直到done返回true结束；value字段返回fileInfo。|
## RootInfo
表示设备的根属性信息和接口能力。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | -------- | ------ | -------- |
| deviceType | number | 是 | 否 |设备类型 |
| uri | string | 是 | 否 | 设备根目录Uri |
| displayName | string | 是 | 否 | 设备名称 |
| deviceFlags | number | 是 | 否 | 设备支持的能力 |
## FileInfo
表示文件(夹)属性信息和接口能力。
**系统能力**：SystemCapability.FileManagement.UserFileService。
**需要权限**：ohos.permission.FILE_ACCESS_MANAGER
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| ------ | ------ | -------- | ------ | -------- |
| uri | string | 是 | 否 | 文件(夹)的uri |
| fileName | string | 是 | 否 | 文件(夹)的名称 |
| mode | number | 是 | 否 | 文件(夹)的权限信息 |
| size | number | 是 | 否 | 文件(夹)的大小 |
| mtime | number | 是 | 否 | 文件(夹)的修改时间 |
| mimeType | string | 是 | 否 | 文件(夹)的媒体资源类型 |
## OPENFLAGS ## OPENFLAGS
目前支持的文件打开的标志位。 目前支持的文件打开的标志位。
......
zh-cn/application-dev/reference/apis/js-apis-fileShare.md
浏览文件 @ 7831ae63
...@@ -3,7 +3,8 @@ ...@@ -3,7 +3,8 @@
该模块提供文件分享能力，提供系统应用将公共目录文件统一资源标志符（Uniform Resource Identifier，URI）以读写权限授权给其他应用的接口，授权后应用可通过[@ohos.file.fs](js-apis-file-fs.md)的相关接口进行相关open、read、write等操作，实现文件分享。 该模块提供文件分享能力，提供系统应用将公共目录文件统一资源标志符（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'; ...@@ -16,8 +17,11 @@ import fileShare from '@ohos.fileShare';
grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback&lt;void&gt;): void grantUriPermission(uri: string, bundleName: string, mode: number, callback: AsyncCallback&lt;void&gt;): void
对公共目录文件URI进行授权操作，使用callback异步回调。 对公共目录文件URI进行授权操作，使用callback异步回调。
**需要权限**：ohos.permission.WRITE_MEDIA **需要权限**：ohos.permission.WRITE_MEDIA
**系统接口**：此接口为系统接口 **系统接口**：此接口为系统接口
**系统能力**：SystemCapability.FileManagement.AppFileService **系统能力**：SystemCapability.FileManagement.AppFileService
**参数：** **参数：**
...@@ -31,15 +35,14 @@ grantUriPermission(uri: string, bundleName: string, mode: number, callback: Asyn ...@@ -31,15 +35,14 @@ grantUriPermission(uri: string, bundleName: string, mode: number, callback: Asyn
**错误码：** **错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导) 以下错误码的详细介绍请参见[文件管理错误码](../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 |
| 错误码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 { ...@@ -62,14 +65,16 @@ try {
} }
``` ```
## fileShare.grantUriPermission ## fileShare.grantUriPermission
grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;void&gt; grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;void&gt;
将公共目录文件URI进行授权操作，使用Promise异步回调。 将公共目录文件URI进行授权操作，使用Promise异步回调。
**需要权限**：ohos.permission.WRITE_MEDIA **需要权限**：ohos.permission.WRITE_MEDIA
**系统接口**：此接口为系统接口 **系统接口**：此接口为系统接口
**系统能力**：SystemCapability.FileManagement.AppFileService **系统能力**：SystemCapability.FileManagement.AppFileService
**参数：** **参数：**
...@@ -86,18 +91,16 @@ grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;vo ...@@ -86,18 +91,16 @@ grantUriPermission(uri: string, bundleName: string, mode: number): Promise&lt;vo
| ---------------------------- | ---------- | | ---------------------------- | ---------- |
| Promise&lt;void&gt; | Promise对象，无返回值 | | Promise&lt;void&gt; | Promise对象，无返回值 |
**错误码：** **错误码：**
以下错误码的详细介绍请参见[文件管理子系统错误码](../errorcodes/errorcode-filemanagement.md#错误码适配指导) 以下错误码的详细介绍请参见[文件管理错误码](../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 |
| 错误码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 { ...@@ -116,4 +119,4 @@ try {
} catch (error) { } catch (error) {
console.error("grantUriPermission failed with error:" + error); console.error("grantUriPermission failed with error:" + error);
} }
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-userFileManager.md
浏览文件 @ 7831ae63
...@@ -2,9 +2,10 @@ ...@@ -2,9 +2,10 @@
该模块提供用户数据管理能力，包括访问、修改用户等用户公共媒体数据信息等常用功能。 该模块提供用户数据管理能力，包括访问、修改用户等用户公共媒体数据信息等常用功能。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > **说明：**
> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 >
> 本模块接口为系统接口。 > - 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口为系统接口。
## 导入模块 ## 导入模块
...@@ -19,10 +20,10 @@ getUserFileMgr(context: Context): UserFileManager ...@@ -19,10 +20,10 @@ getUserFileMgr(context: Context): UserFileManager
获取用户数据管理模块的实例，用于访问和修改用户等用户公共媒体数据信息（如音频、视频、图片、文档等）。 获取用户数据管理模块的实例，用于访问和修改用户等用户公共媒体数据信息（如音频、视频、图片、文档等）。
**模型约束：** 此接口仅可在Stage模型下使用。 **模型约束：** 此接口仅可在Stage模型下使用。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| ------- | ------- | ---- | -------------------------- | | ------- | ------- | ---- | -------------------------- |
...@@ -48,11 +49,8 @@ let mgr = userFileManager.getUserFileMgr(context); ...@@ -48,11 +49,8 @@ let mgr = userFileManager.getUserFileMgr(context);
getPhotoAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void; getPhotoAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;
获取图片和视频资源，使用callback方式返回结果。 获取图片和视频资源，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**需要权限**：ohos.permission.READ_IMAGEVIDEO **需要权限**：ohos.permission.READ_IMAGEVIDEO
...@@ -91,7 +89,6 @@ async function example() { ...@@ -91,7 +89,6 @@ async function example() {
} }
``` ```
### getPhotoAssets ### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;; getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
...@@ -108,7 +105,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g ...@@ -108,7 +105,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| ------- | ------------------- | ---- | ---------------- | | ------- | ------------------- | ---- | ---------------- |
| options | [FetchOptions](#fetchoptions) | 是 | 图片和视频检索选项 | | options | [FetchOptions](#fetchoptions) | 是 | 图片和视频检索选项 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | -------------- |
...@@ -140,6 +137,7 @@ async function example() { ...@@ -140,6 +137,7 @@ async function example() {
} }
} }
``` ```
### createPhotoAsset ### createPhotoAsset
createPhotoAsset(displayName: string, albumUri: string, callback: AsyncCallback&lt;FileAsset&gt;): void; createPhotoAsset(displayName: string, albumUri: string, callback: AsyncCallback&lt;FileAsset&gt;): void;
...@@ -234,7 +232,7 @@ createPhotoAsset(displayName: string, albumUri?: string): Promise&lt;FileAsset&g ...@@ -234,7 +232,7 @@ createPhotoAsset(displayName: string, albumUri?: string): Promise&lt;FileAsset&g
| displayName | string | 是 | 创建的图片或者视频文件名 | | displayName | string | 是 | 创建的图片或者视频文件名 |
| albumUri | string | 否 | 创建的图片或者视频所在相册的uri | | albumUri | string | 否 | 创建的图片或者视频所在相册的uri |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | -------------- |
...@@ -260,7 +258,6 @@ async function example() { ...@@ -260,7 +258,6 @@ async function example() {
getPhotoAlbums(options: AlbumFetchOptions, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void; getPhotoAlbums(options: AlbumFetchOptions, callback: AsyncCallback&lt;FetchResult&lt;Album&gt;&gt;): void;
获取相册，使用callback方式返回结果。 获取相册，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
...@@ -319,7 +316,7 @@ getPhotoAlbums(options: AlbumFetchOptions): Promise&lt;FetchResult&lt;Album&gt;& ...@@ -319,7 +316,7 @@ getPhotoAlbums(options: AlbumFetchOptions): Promise&lt;FetchResult&lt;Album&gt;&
| -------- | ------------------------ | ---- | ------------------------- | | -------- | ------------------------ | ---- | ------------------------- |
| options | [AlbumFetchOptions](#albumfetchoptions) | 是 | 相册检索选项 | | options | [AlbumFetchOptions](#albumfetchoptions) | 是 | 相册检索选项 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | -------------- |
...@@ -351,7 +348,6 @@ async function example() { ...@@ -351,7 +348,6 @@ async function example() {
getPrivateAlbum(type: PrivateAlbumType, callback: AsyncCallback&lt;FetchResult&lt;PrivateAlbum&gt;&gt;): void; getPrivateAlbum(type: PrivateAlbumType, callback: AsyncCallback&lt;FetchResult&lt;PrivateAlbum&gt;&gt;): void;
获取系统相册，使用 callback 方式返回系统相册的数组。 获取系统相册，使用 callback 方式返回系统相册的数组。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
...@@ -398,7 +394,7 @@ getPrivateAlbum(type: PrivateAlbumType): Promise&lt;FetchResult&lt;PrivateAlbum& ...@@ -398,7 +394,7 @@ getPrivateAlbum(type: PrivateAlbumType): Promise&lt;FetchResult&lt;PrivateAlbum&
| -------- | ------------------------ | ---- | ------------------------- | | -------- | ------------------------ | ---- | ------------------------- |
| type | [PrivateAlbumType](#privatealbumtype) | 是 | 系统相册类型 | | type | [PrivateAlbumType](#privatealbumtype) | 是 | 系统相册类型 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | -------------- |
...@@ -423,7 +419,6 @@ async function example() { ...@@ -423,7 +419,6 @@ async function example() {
getAudioAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void; getAudioAssets(options: FetchOptions, callback: AsyncCallback&lt;FetchResult&lt;FileAsset&gt;&gt;): void;
获取音频文件，使用callback方式返回结果。 获取音频文件，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
...@@ -468,7 +463,6 @@ async function example() { ...@@ -468,7 +463,6 @@ async function example() {
getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;; getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
获取音频文件，使用callback方式返回结果。 获取音频文件，使用callback方式返回结果。
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
...@@ -481,7 +475,7 @@ getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g ...@@ -481,7 +475,7 @@ getAudioAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| -------- | ------------------------ | ---- | ------------------------- | | -------- | ------------------------ | ---- | ------------------------- |
| options | [FetchOptions](#fetchoptions) | 是 | 检索选项 | | options | [FetchOptions](#fetchoptions) | 是 | 检索选项 |
**返回值** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------- | -------------- | | --------------------------- | -------------- |
...@@ -514,6 +508,7 @@ async function example() { ...@@ -514,6 +508,7 @@ async function example() {
} }
} }
``` ```
### delete ### delete
delete(uri: string, callback: AsyncCallback&lt;void&gt;): void; delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;
...@@ -563,6 +558,7 @@ async function example() { ...@@ -563,6 +558,7 @@ async function example() {
}); });
} }
``` ```
### delete ### delete
delete(uri: string): Promise&lt;void&gt;; delete(uri: string): Promise&lt;void&gt;;
...@@ -579,7 +575,7 @@ delete(uri: string): Promise&lt;void&gt;; ...@@ -579,7 +575,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 媒体文件uri | | uri | string | 是 | 媒体文件uri |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1092,7 +1088,6 @@ open(mode: string, callback: AsyncCallback&lt;number&gt;): void ...@@ -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 **需要权限**：ohos.permission.READ_IMAGEVIDEO 或 ohos.permission.READ_AUDIO 或 ohos.permission.WRITE_IMAGEVIDEO 或 ohos.permission.WRITE_AUDIO
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**参数** **参数**
...@@ -1482,7 +1477,7 @@ getCount(): number ...@@ -1482,7 +1477,7 @@ getCount(): number
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------ | -------- | | ------ | -------- |
...@@ -1514,7 +1509,7 @@ isAfterLast(): boolean ...@@ -1514,7 +1509,7 @@ isAfterLast(): boolean
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------- | ---------------------------------- | | ------- | ---------------------------------- |
...@@ -1618,7 +1613,7 @@ getFirstObject(): Promise&lt;T&gt; ...@@ -1618,7 +1613,7 @@ getFirstObject(): Promise&lt;T&gt;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | -------------------------- | | --------------------------------------- | -------------------------- |
...@@ -1690,7 +1685,7 @@ async function example() { ...@@ -1690,7 +1685,7 @@ async function example() {
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1762,7 +1757,7 @@ getLastObject(): Promise&lt;T&gt; ...@@ -1762,7 +1757,7 @@ getLastObject(): Promise&lt;T&gt;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1838,7 +1833,7 @@ getPositionObject(index: number): Promise&lt;T&gt; ...@@ -1838,7 +1833,7 @@ getPositionObject(index: number): Promise&lt;T&gt;
| ----- | ------ | ---- | -------------- | | ----- | ------ | ---- | -------------- |
| index | number | 是 | 要获取的文件的索引，从0开始 | | index | number | 是 | 要获取的文件的索引，从0开始 |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -1922,6 +1917,7 @@ async function example() { ...@@ -1922,6 +1917,7 @@ async function example() {
}); });
} }
``` ```
### getPhotoAssets ### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;; getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
...@@ -2015,7 +2011,7 @@ commitModify(): Promise&lt;void&gt;; ...@@ -2015,7 +2011,7 @@ commitModify(): Promise&lt;void&gt;;
**系统能力**：SystemCapability.FileManagement.UserFileManager.Core **系统能力**：SystemCapability.FileManagement.UserFileManager.Core
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| ------------------- | ------------ | | ------------------- | ------------ |
...@@ -2105,6 +2101,7 @@ async function example() { ...@@ -2105,6 +2101,7 @@ async function example() {
} }
``` ```
### getPhotoAssets ### getPhotoAssets
getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;; getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&gt;;
...@@ -2121,7 +2118,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g ...@@ -2121,7 +2118,7 @@ getPhotoAssets(options: FetchOptions): Promise&lt;FetchResult&lt;FileAsset&gt;&g
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| options | [FetchOptions](#fetchoptions) | 是 | 检索选项 | | options | [FetchOptions](#fetchoptions) | 是 | 检索选项 |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2146,6 +2143,7 @@ async function example() { ...@@ -2146,6 +2143,7 @@ async function example() {
console.info('fetchResult.count = ', count); console.info('fetchResult.count = ', count);
} }
``` ```
### delete ### delete
delete(uri: string, callback: AsyncCallback&lt;void&gt;): void; delete(uri: string, callback: AsyncCallback&lt;void&gt;): void;
...@@ -2189,6 +2187,7 @@ async function example() { ...@@ -2189,6 +2187,7 @@ async function example() {
}); });
} }
``` ```
### delete ### delete
delete(uri: string): Promise&lt;void&gt;; delete(uri: string): Promise&lt;void&gt;;
...@@ -2205,7 +2204,7 @@ delete(uri: string): Promise&lt;void&gt;; ...@@ -2205,7 +2204,7 @@ delete(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri | | uri | string | 是 | 相册uri |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2279,6 +2278,7 @@ async function example() { ...@@ -2279,6 +2278,7 @@ async function example() {
}); });
} }
``` ```
### recover ### recover
recover(uri: string): Promise&lt;void&gt;; recover(uri: string): Promise&lt;void&gt;;
...@@ -2295,7 +2295,7 @@ recover(uri: string): Promise&lt;void&gt;; ...@@ -2295,7 +2295,7 @@ recover(uri: string): Promise&lt;void&gt;;
| -------- | ------------------------- | ---- | ---------- | | -------- | ------------------------- | ---- | ---------- |
| uri | string | 是 | 相册uri | | uri | string | 是 | 相册uri |
**返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------------- | ----------------- | | --------------------------------------- | ----------------- |
...@@ -2331,12 +2331,12 @@ async function example() { ...@@ -2331,12 +2331,12 @@ async function example() {
成员类型。 成员类型。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.FileManagement.UserFileManager.Core **系统能力：** 以下各项对应的系统能力均为SystemCapability.FileManagement.UserFileManager.Core
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ----- | ---- | ---- | ---- | ---- | | ----- | ---- | ---- | ---- | ---- |
| number | number | 是 | 是 | number类型 | | number | number | 是 | 是 | number类型 |
| string | string | 是 | 是 | string类型 | | string | string | 是 | 是 | string类型 |
| boolean | boolean | 是 | 是 | boolean类型 | | boolean | boolean | 是 | 是 | boolean类型 |
## ChangeEvent ## ChangeEvent
...@@ -2365,7 +2365,6 @@ async function example() { ...@@ -2365,7 +2365,6 @@ async function example() {
| networkId | string | 是 | 否 | 注册设备的网络ID | | networkId | string | 是 | 否 | 注册设备的网络ID |
| isOnline | boolean | 是 | 否 | 是否在线 | | isOnline | boolean | 是 | 否 | 是否在线 |
## FileType ## FileType
枚举，媒体文件类型。 枚举，媒体文件类型。
...@@ -2389,8 +2388,6 @@ async function example() { ...@@ -2389,8 +2388,6 @@ async function example() {
| TYPE_FAVORITE | 0 | 收藏夹相册 | | TYPE_FAVORITE | 0 | 收藏夹相册 |
| TYPE_TRASH | 1 | 回收站相册 | | TYPE_TRASH | 1 | 回收站相册 |
## AudioKey ## AudioKey
枚举，音频文件关键信息。 枚举，音频文件关键信息。
...@@ -2444,7 +2441,6 @@ async function example() { ...@@ -2444,7 +2441,6 @@ async function example() {
| DATE_ADDED | date_added | 添加日期（添加文件时间到1970年1月1日的秒数值） | | DATE_ADDED | date_added | 添加日期（添加文件时间到1970年1月1日的秒数值） |
| DATE_MODIFIED | date_modified | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新） | | DATE_MODIFIED | date_modified | 修改日期（修改文件时间到1970年1月1日的秒数值，修改文件名不会改变此值，当文件内容发生修改时才会更新） |
## FetchOptions ## FetchOptions
检索条件。 检索条件。
...@@ -2465,4 +2461,3 @@ async function example() { ...@@ -2465,4 +2461,3 @@ async function example() {
| 名称 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| ---------------------- | ------------------- | ---- |---- | ------------------------------------------------ | | ---------------------- | ------------------- | ---- |---- | ------------------------------------------------ |
| predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md) | 是 | 是 | 谓词查询，显示过滤条件 | | predicates | [dataSharePredicates.DataSharePredicates](js-apis-data-dataSharePredicates.md) | 是 | 是 | 谓词查询，显示过滤条件 |
zh-cn/application-dev/reference/errorcodes/errorcode-filemanagement.md
浏览文件 @ 7831ae63
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
> >
> 以下仅介绍本模块特有错误码，通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。 > 以下仅介绍本模块特有错误码，通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。
文件管理子系统错误码由四部分组成，分别是基础文件IO错误码、用户数据管理错误码、公共文件访问错误码和空间统计错误码组成。 文件管理子系统错误码由四部分组成，分别是[基础文件IO错误码](#基础文件io错误码)、[用户数据管理错误码](#用户数据管理错误码)、[公共文件访问错误码](#公共文件访问错误码)和[空间统计错误码](#空间统计错误码)组成。
## 基础文件IO错误码 ## 基础文件IO错误码
...@@ -719,41 +719,3 @@ Fail to notify agent ...@@ -719,41 +719,3 @@ Fail to notify agent
**处理步骤** **处理步骤**
检查client是否异常 检查client是否异常
## 错误码适配指导
文件管理子系统API支持异常处理。
同步接口异常处理示例代码:
```js
import fs from '@ohos.file.fs'
try {
let file = fs.openSync(path, fs.OpenMode.READ_ONLY);
} catch (err) {
console.error("openSync errCode:" + err.code + ", errMessage:" + err.message);
}
```
异步接口promise方法异常处理示例代码:
```js
import fs from '@ohos.file.fs'
try {
let file = await fs.open(path, fs.OpenMode.READ_ONLY);
} catch (err) {
console.error("open promise errCode:" + err.code + ", errMessage:" + err.message);
}
```
异步接口callback方法异常处理示例代码:
```js
import fs from '@ohos.file.fs'
try {
fs.open(path, fs.OpenMode.READ_ONLY, function(e, file){ //异步线程的错误（如系统调用等）在回调中获取
if (e) {
console.error("open in async errCode:" + e.code + ", errMessage:" + e.message);
}
});
} catch (err) { //主线程的错误（如非法参数等）通过try catch获取
console.error("open callback errCode:" + err.code + ", errMessage:" + err.message);
}
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或