diff --git a/zh-cn/application-dev/dfx/hiappevent-guidelines.md b/zh-cn/application-dev/dfx/hiappevent-guidelines.md index bf190350460c53329cded1e9371402364b46d6d7..e2d75afbbdee3e8f949e87ebfb7a7375a3e12bb5 100644 --- a/zh-cn/application-dev/dfx/hiappevent-guidelines.md +++ b/zh-cn/application-dev/dfx/hiappevent-guidelines.md @@ -17,7 +17,7 @@ | write(string eventName, EventType type, object keyValues, AsyncCallback\ callback): void | void | 应用事件异步打点方法，使用callback方式作为异步回调。 | | write(string eventName, EventType type, object keyValues): Promise\ | Promise\ | 应用事件异步打点方法，使用promise方式作为异步回调。 | -当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](hiappevent-overview.md#事件校验结果码)。 +当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](#事件校验结果码)。 **打点配置接口功能介绍：** @@ -25,6 +25,23 @@ | ------------------------------ | ------- | ------------------------------------------------------------ | | configure(ConfigOption config) | boolean | 应用事件打点配置方法，可以对打点功能进行自定义配置。返回true表示配置成功，false表示配置失败。 | +### 事件校验结果码 + +| 错误码 | 原因 | 校验规则 | 处理结果 | +| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| 0 | 无 | 事件校验成功 | 事件正常打点。 | +| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。 | 忽略该事件，不执行打点。 | +| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。
事件类型参数必须为number类型。
keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 | +| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 | +| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 | +| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。
非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 | +| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 | +| 3 | 无效的value参数类型 | value参数只支持以下类型：
boolean、number、string、Array[基本类型]。
| 忽略该键值对参数后，继续执行打点。 | +| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 | +| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 | +| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 | +| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。
List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 | + ## 开发步骤 在应用启动执行页面加载后，执行一个应用事件打点，用于记录应用的初始页面加载事件。 diff --git a/zh-cn/application-dev/dfx/hiappevent-overview.md b/zh-cn/application-dev/dfx/hiappevent-overview.md index e4965580756d232ec0edf3cc48411b90c890c2a2..8dfe1d52999e3a9f55bf111ed3bcb9378197f27c 100644 --- a/zh-cn/application-dev/dfx/hiappevent-overview.md +++ b/zh-cn/application-dev/dfx/hiappevent-overview.md @@ -6,21 +6,4 @@ HiAppEvent提供了应用事件打点接口，为应用提供事件打点的功 HiAppEvent模块支持应用事件业务的开发，提供应用事件相关的功能，主要包括应用事件落盘、查询历史应用事件数据等功能。 -**打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。 - -## 事件校验结果码 - -| 错误码 | 原因 | 校验规则 | 处理结果 | -| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| 0 | 无 | 事件校验成功 | 事件正常打点。 | -| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。 | 忽略该事件，不执行打点。 | -| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。
事件类型参数必须为number类型。
keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 | -| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 | -| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 | -| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。
只由以下字符组成：0-9、a-z、_。
非数字以及下划线开头。
非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 | -| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 | -| 3 | 无效的value参数类型 | value参数只支持以下类型：
boolean、number、string、Array[基本类型]。
| 忽略该键值对参数后，继续执行打点。 | -| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 | -| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 | -| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 | -| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。
List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 | \ No newline at end of file +**打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。 \ No newline at end of file diff --git a/zh-cn/application-dev/dfx/hitracemeter-overview.md b/zh-cn/application-dev/dfx/hitracemeter-overview.md index a6144101ad710c69bf7a8833580c2a4142438df0..8c7b503c7705153663ed598923bb510fc5bb6fdb 100644 --- a/zh-cn/application-dev/dfx/hitracemeter-overview.md +++ b/zh-cn/application-dev/dfx/hitracemeter-overview.md @@ -6,7 +6,7 @@ hiTraceMeter是开发者用于追踪进程轨迹，度量程序执行性能的 - **hiTraceMeter Tag** - 跟踪数据使用类别分类，称作hiTraceMeter Tag或hiTraceMeter Category，一般每个软件子系统对应一个Tag，该Tag在打点API中以类别TAg参数传入。hiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。 + 跟踪数据使用类别分类，称作hiTraceMeter Tag或hiTraceMeter Category，一般每个软件子系统对应一个Tag，该Tag在打点API中以类别Tag参数传入。hiTraceMeter命令行工具采集跟踪数据时，只采集给定的Tag类别选项指定的跟踪数据。 ## 运作机制 diff --git a/zh-cn/application-dev/reference/apis/js-apis-document.md b/zh-cn/application-dev/reference/apis/js-apis-document.md index 4218d25e7491b2fb60659416f0dd91648b8aa6bc..01d6e24a1c50a71f3e42bdf383315a6fc48e43d6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-document.md +++ b/zh-cn/application-dev/reference/apis/js-apis-document.md @@ -1,8 +1,8 @@ # 文件交互 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -- 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -- 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。 +> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。 ## 导入模块 diff --git a/zh-cn/application-dev/reference/apis/js-apis-fileio.md b/zh-cn/application-dev/reference/apis/js-apis-fileio.md index f04103f1e8b72a2e166db480680504996b57963a..fc4205ce6cf0407ba851aceff378213e2abf89f6 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-fileio.md +++ b/zh-cn/application-dev/reference/apis/js-apis-fileio.md @@ -14,11 +14,11 @@ import fileio from '@ohos.fileio'; ## 使用说明 -使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” +“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名” -通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为： +通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在应用沙箱路径为： ```js let path = dir + "/xxx.txt"; @@ -43,9 +43,9 @@ stat(path: string): Promise<Stat> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待获取文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待获取文件的应用沙箱路径。 | **返回值：** @@ -72,10 +72,10 @@ stat(path:string, callback:AsyncCallback<Stat>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | --------------- | - | path | string | 是 | 待获取文件的绝对路径。 | - | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待获取文件的应用沙箱路径。 | +| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取文件的信息之后的回调。 | **示例：** ```js @@ -94,9 +94,9 @@ statSync(path:string): Stat **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待获取文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待获取文件的应用沙箱路径。 | **返回值：** @@ -120,9 +120,9 @@ opendir(path: string): Promise<Dir> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -149,10 +149,10 @@ opendir(path: string, callback: AsyncCallback<Dir>): void **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | -------------------------------- | ---- | -------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | - | callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | +| callback | AsyncCallback<[Dir](#dir)> | 是 | 异步打开文件目录之后的回调。 | **示例：** ```js @@ -174,9 +174,9 @@ opendirSync(path: string): Dir **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ------------- | - | path | string | 是 | 待打开文件目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------ | +| path | string | 是 | 待打开文件目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -201,10 +201,10 @@ access(path: string, mode?: number): Promise<void> **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | **返回值：** | 类型 | 说明 | @@ -230,11 +230,11 @@ access(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | - | callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| callback | AsyncCallback<void> | 是 | 异步检查当前进程是否可访问某文件之后的回调。 | **示例：** ```js @@ -253,10 +253,10 @@ accessSync(path: string, mode?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待访问文件的绝对路径。 | - | mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待访问文件的应用沙箱路径。 | +| mode | number | 否 | 访问文件时的选项，可给定如下选项，以按位或的方式使用多个选项，默认给定0。
确认当前进程是否具有对应权限：
- 0：确认文件是否存在。
- 1：确认当前进程是否具有可执行权限。
- 2：确认当前进程是否具有写权限。
- 4：确认当前进程是否具有读权限。 | **示例：** ```js @@ -467,10 +467,10 @@ mkdir(path:string, mode?: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -496,11 +496,11 @@ mkdir(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback<void> | 是 | 异步创建目录操作完成之后的回调。 | **示例：** ```js @@ -519,10 +519,10 @@ mkdirSync(path: string, mode?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待创建目录的绝对路径。 | - | mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待创建目录的应用沙箱路径。 | +| mode | number | 否 | 创建目录的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o775。
- 0o775：所有者具有读、写及可执行权限，其余用户具有读及可执行权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **示例：** ```js @@ -539,11 +539,11 @@ open(path: string, flags?: number, mode?: number): Promise<number> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -569,12 +569,12 @@ open(path: string, flags: number, mode: number, callback: AsyncCallback<numbe **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 是 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 是 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 是 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback <void> | 是 | 异步打开文件之后的回调。 | **示例：** ```js @@ -593,11 +593,11 @@ openSync(path:string, flags?:number, mode?:number): number **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ----- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | - | mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| flags | number | 否 | 打开文件的选项，必须指定如下选项中的一个，默认以只读方式打开：
- 0o0：只读打开。
- 0o1：只写打开。
- 0o2：读写打开。
同时，也可给定如下选项，以按位或的方式追加，默认不给定任何额外选项：
- 0o100：若文件不存在，则创建文件。使用该选项时必须指定第三个参数 mode。
- 0o200：如果追加了0o100选项，且文件已经存在，则出错。
- 0o1000：如果文件存在且以只写或读写的方式打开文件，则将其长度裁剪为零。
- 0o2000：以追加方式打开，后续写将追加到文件末尾。
- 0o4000：如果path指向FIFO、块特殊文件或字符特殊文件，则本次打开及后续 IO 进行非阻塞操作。
- 0o200000：如果path指向目录，则出错。
- 0o400000：如果path指向符号链接，则出错。
- 0o4010000：以同步IO的方式打开文件。 | +| mode | number | 否 | 若创建文件，则指定文件的权限，可给定如下权限，以按位或的方式追加权限，默认给定0o666。
- 0o666：所有者具有读、写权限，所有用户组具有读、写权限，其余用户具有读、写权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。
创建出的文件权限受umask影响，umask随进程启动确定，其修改当前不开放。 | **返回值：** | 类型 | 说明 | @@ -722,9 +722,9 @@ rmdir(path: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -750,10 +750,10 @@ rmdir(path: string, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------ | - | path | string | 是 | 待删除目录的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步删除目录之后的回调。 | **示例：** ```js @@ -773,9 +773,9 @@ rmdirSync(path: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除目录的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除目录的应用沙箱路径。 | **示例：** ```js @@ -792,9 +792,9 @@ unlink(path:string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -820,10 +820,10 @@ unlink(path:string, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------ | - | path | string | 是 | 待删除文件的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步删除文件之后的回调。 | **示例：** ```js @@ -842,9 +842,9 @@ unlinkSync(path: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待删除文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待删除文件的应用沙箱路径。 | **示例：** ```js @@ -961,10 +961,10 @@ hash(path: string, algorithm: string): Promise<string> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | --------- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待计算哈希值文件的绝对路径。 | - | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待计算哈希值文件的应用沙箱路径。 | +| algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | **返回值：** | 类型 | 说明 | @@ -990,11 +990,11 @@ hash(path: string, algorithm: string, callback: AsyncCallback<string>): vo **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | --------- | --------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待计算哈希值文件的绝对路径。 | - | algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | - | callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 | +| 参数名 | 类型 | 必填 | 说明 | +| --------- | --------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待计算哈希值文件的应用沙箱路径。 | +| algorithm | string | 是 | 哈希计算采用的算法。可选 "md5"、"sha1" 或 "sha256"。建议采用安全强度更高的 "sha256"。 | +| callback | AsyncCallback<string> | 是 | 异步计算文件哈希操之后的回调函数（其中给定文件哈希值表示为十六进制数字串，所有字母均大写）。 | **示例：** ```js @@ -1015,10 +1015,10 @@ chmod(path: string, mode: number):Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **返回值：** | 类型 | 说明 | @@ -1044,11 +1044,11 @@ chmod(path: string, mode: number, callback: AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件权限之后的回调。 | **示例：** ```js @@ -1067,10 +1067,10 @@ chmodSync(path: string, mode: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待改变文件权限的绝对路径。 | - | mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待改变文件权限的应用沙箱路径。 | +| mode | number | 是 | 改变文件权限，可给定如下权限，以按位或的方式追加权限。
- 0o700：所有者具有读、写及可执行权限。
- 0o400：所有者具有读权限。
- 0o200：所有者具有写权限。
- 0o100：所有者具有可执行权限。
- 0o070：所有用户组具有读、写及可执行权限。
- 0o040：所有用户组具有读权限。
- 0o020：所有用户组具有写权限。
- 0o010：所有用户组具有可执行权限。
- 0o007：其余用户具有读、写及可执行权限。
- 0o004：其余用户具有读权限。
- 0o002：其余用户具有写权限。
- 0o001：其余用户具有可执行权限。 | **示例：** ```js @@ -1236,10 +1236,10 @@ truncate(path: string, len?: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 是 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 是 | 文件截断后的长度，以字节为单位。 | **返回值：** | 类型 | 说明 | @@ -1265,11 +1265,11 @@ truncate(path: string, len: number, callback:AsyncCallback<void>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 是 | 文件截断后的长度，以字节为单位。 | - | callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 是 | 文件截断后的长度，以字节为单位。 | +| callback | AsyncCallback<void> | 是 | 异步截断文件的信息之后的回调。 | **示例：** ```js @@ -1288,10 +1288,10 @@ truncateSync(path: string, len?: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------- | - | path | string | 是 | 待截断文件的绝对路径。 | - | len | number | 否 | 文件截断后的长度，以字节为单位。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------- | +| path | string | 是 | 待截断文件的应用沙箱路径。 | +| len | number | 否 | 文件截断后的长度，以字节为单位。 | **示例：** ```js @@ -1312,10 +1312,10 @@ readText(filePath: string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------ | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** | 类型 | 说明 | @@ -1345,11 +1345,11 @@ readText(filePath: string, options: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------- | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | - | callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------- | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| callback | AsyncCallback<string> | 是 | 异步通过文本方式读取文件之后的回调。 | **示例：** ```js @@ -1372,10 +1372,10 @@ readTextSync(filePath: string, options?: { **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------ | ---- | ---------------------------------------- | - | filePath | string | 是 | 待读取文件的绝对路径。 | - | options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------ | ---- | ------------------------------------------------------------ | +| filePath | string | 是 | 待读取文件的应用沙箱路径。 | +| options | Object | 否 | 支持如下选项：
- position，number类型，表示期望读取文件的位置。可选，默认从当前位置开始读取。
- length，number类型，表示期望读取数据的长度。可选，默认缓冲区长度减去偏移长度。
- encoding，string类型，当数据是 string 类型时有效，表示数据的编码方式，默认 'utf-8'，仅支持 'utf-8'。 | **返回值：** | 类型 | 说明 | @@ -1397,9 +1397,9 @@ lstat(path: string): Promise<Stat> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | **返回值：** | 类型 | 说明 | @@ -1425,10 +1425,10 @@ lstat(path:string, callback:AsyncCallback<Stat>): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ---------------------------------- | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | - | callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ---------------------------------- | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | +| callback | AsyncCallback<[Stat](#stat)> | 是 | 异步获取链接状态信息之后的回调。 | **示例：** ```js @@ -1447,9 +1447,9 @@ lstatSync(path:string): Stat **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------------- | - | path | string | 是 | 目标文件的绝对路径，指向链接状态。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------------------- | +| path | string | 是 | 目标文件的应用沙箱路径，指向链接状态。 | **返回值：** | 类型 | 说明 | @@ -1536,10 +1536,10 @@ rename(oldPath: string, newPath: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------------------ | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -1565,11 +1565,11 @@ rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ------------- | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | - | Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | +| Callback | AsyncCallback<void> | 是 | 异步重命名文件之后的回调。 | **示例：** ```js @@ -1587,10 +1587,10 @@ renameSync(oldPath: string, newPath: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | oldPath | string | 是 | 目标文件的当前绝对路径。 | - | newPath | String | 是 | 目标文件的新绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| oldPath | string | 是 | 目标文件的当前应用沙箱路径。 | +| newPath | String | 是 | 目标文件的新应用沙箱路径。 | **示例：** ```js @@ -1745,10 +1745,10 @@ symlink(target: string, srcPath: string): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | **返回值：** | 类型 | 说明 | @@ -1774,11 +1774,11 @@ symlink(target: string, srcPath: string, callback: AsyncCallback<void>): v **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | ---------------- | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | - | callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | -------------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | +| callback | AsyncCallback<void> | 是 | 异步创建符号链接信息之后的回调。 | **示例：** ```js @@ -1797,10 +1797,10 @@ symlinkSync(target: string, srcPath: string): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ------- | ------ | ---- | ------------ | - | target | string | 是 | 目标文件的绝对路径。 | - | srcPath | string | 是 | 符号链接文件的绝对路径。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------- | ------ | ---- | ---------------------------- | +| target | string | 是 | 目标文件的应用沙箱路径。 | +| srcPath | string | 是 | 符号链接文件的应用沙箱路径。 | **示例：** ```js @@ -1817,11 +1817,11 @@ chown(path: string, uid: number, gid: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | --------------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID（UserID）。 | - | gid | number | 是 | 新的GID（GroupID）。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID（UserID）。 | +| gid | number | 是 | 新的GID（GroupID）。 | **返回值：** | 类型 | 说明 | @@ -1848,12 +1848,12 @@ chown(path: string, uid: number, gid: number, callback: AsyncCallback<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | **示例：** ```js @@ -1873,11 +1873,11 @@ chownSync(path: string, uid: number, gid: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待改变文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待改变文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **示例：** ```js @@ -2041,10 +2041,10 @@ createStream(path: string, mode: string): Promise<Stream> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** | 类型 | 说明 | @@ -2070,11 +2070,11 @@ createStream(path: string, mode: string, callback: AsyncCallback<Stream>): **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------------- | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | - | callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| callback | AsyncCallback<[Stream](#stream7)> | 是 | 异步打开文件流之后的回调。 | **示例：** ```js @@ -2093,10 +2093,10 @@ createStreamSync(path: string, mode: string): Stream **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ---------------------------------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | ------------------------------------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| mode | string | 是 | - r：打开只读文件，该文件必须存在。
- r+：打开可读写的文件，该文件必须存在。
- w：打开只写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- w+：打开可读写文件，若文件存在则文件长度清0，即该文件内容会消失。若文件不存在则建立该文件。
- a：以附加的方式打开只写文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾，即文件原先的内容会被保留。
- a+：以附加方式打开可读写的文件。若文件不存在，则会建立该文件，如果文件存在，写入的数据会被加到文件尾后，即文件原先的内容会被保留。 | **返回值：** | 类型 | 说明 | @@ -2273,11 +2273,11 @@ lchown(path: string, uid: number, gid: number): Promise<void> **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **返回值：** | 类型 | 说明 | @@ -2304,12 +2304,12 @@ lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void&g **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | ------------------------- | ---- | --------------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | - | callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | ------------------------- | ---- | ------------------------------ | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | +| callback | AsyncCallback<void> | 是 | 异步改变文件所有者之后的回调。 | **示例：** ```js @@ -2329,11 +2329,11 @@ lchownSync(path: string, uid: number, gid: number): void **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | ---- | ------ | ---- | ----------- | - | path | string | 是 | 待打开文件的绝对路径。 | - | uid | number | 是 | 新的UID。 | - | gid | number | 是 | 新的GID。 | +| 参数名 | 类型 | 必填 | 说明 | +| ------ | ------ | ---- | -------------------------- | +| path | string | 是 | 待打开文件的应用沙箱路径。 | +| uid | number | 是 | 新的UID。 | +| gid | number | 是 | 新的GID。 | **示例：** ```js @@ -2351,11 +2351,11 @@ createWatcher(filename: string, events: number, callback: AsyncCallback<numbe **系统能力**：SystemCapability.FileManagement.File.FileIO **参数：** - | 参数名 | 类型 | 必填 | 说明 | - | -------- | --------------------------------- | ---- | ---------------------------------------- | - | filename | string | 是 | 待监视文件的绝对路径。 | - | events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2：监听文件或者目录内容的是否修改。
- 3：两者都有。 | - | callback | AsyncCallback<number > | 是 | 每发生变化一次，调用一次此函数。 | +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------- | ---- | ------------------------------------------------------------ | +| filename | string | 是 | 待监视文件的应用沙箱路径。 | +| events | Number | 是 | - 1: 监听文件或者目录是否发生重命名。
- 2：监听文件或者目录内容的是否修改。
- 3：两者都有。 | +| callback | AsyncCallback<number > | 是 | 每发生变化一次，调用一次此函数。 | **返回值：** | 类型 | 说明 | diff --git a/zh-cn/application-dev/reference/apis/js-apis-image.md b/zh-cn/application-dev/reference/apis/js-apis-image.md index 41474e836523bf94e153e4aed203e9e8760e03dd..af4e587c014066f6da0f3ff356c04d2c1eb2290f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-image.md +++ b/zh-cn/application-dev/reference/apis/js-apis-image.md @@ -470,7 +470,7 @@ createImageSource(uri: string): ImageSource | 参数名 | 类型 | 必填 | 说明 | | ------ | ------ | ---- | ---------------------------------- | -| uri | string | 是 | 图片路径，当前仅支持本地绝对路径。 | +| uri | string | 是 | 图片路径，当前仅支持应用沙箱路径。 | **返回值：** @@ -481,7 +481,8 @@ createImageSource(uri: string): ImageSource **示例：** ```js -const imageSourceApi = image.createImageSource('/data/local/tmp/test.jpg') +let path = this.context.getApplicationContext().fileDirs + "test.jpg"; +const imageSourceApi = image.createImageSource(path); ``` ## image.createImageSource7+ diff --git a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md index d3b7be68f0336cd8f6082393d8f6ffdc7343aace..b26634cbf025d0ca58c7c1ed369d5990d46311f3 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md +++ b/zh-cn/application-dev/reference/apis/js-apis-medialibrary.md @@ -2227,11 +2227,11 @@ async function example() { **系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core -| 名称 | 类型 | 必填 | 描述 | -| ------------ | ------ | ---- | ---------------------------------------- | -| src | string | 是 | 应用本地文件绝对路径。 | -| mimeType | string | 是 | 媒体MIME（Multipurpose Internet Mail Extensions）类型。
包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | -| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。
image类型默认路径Pictures/
video类型默认路径Videos/
audio类型默认路径Audios/
file类型默认路径Documents/ 。 | +| 名称 | 类型 | 必填 | 描述 | +| ------------ | ------ | ---- | ------------------------------------------------------------ | +| src | string | 是 | 本地文件应用沙箱路径。 | +| mimeType | string | 是 | 媒体MIME（Multipurpose Internet Mail Extensions）类型。
包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 | +| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。
image类型默认路径Pictures/
video类型默认路径Videos/
audio类型默认路径Audios/
file类型默认路径Documents/ 。 | ## MediaSelectOption(deprecated) diff --git a/zh-cn/application-dev/reference/apis/js-apis-statfs.md b/zh-cn/application-dev/reference/apis/js-apis-statfs.md index 31ebb1e04290ce9d962d6aed2fa7feb625ec2a0b..fb5a81bd330d1e919c282620af2932e024e0091f 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-statfs.md +++ b/zh-cn/application-dev/reference/apis/js-apis-statfs.md @@ -13,11 +13,11 @@ import statfs from '@ohos.statfs'; ## 使用说明 -使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 +使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。 -“文件/目录绝对路径”=“应用目录路径”+“文件/目录名” +“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名” -通过上述接口获取到应用目录路径dir，以文件名“xxx.txt”为例，文件所在绝对路径为： +通过上述接口获取到应用目录路径dir，以文件名“xxx.txt”为例，文件所在应用沙箱路径为： ```js let path = dir + "xxx.txt"; diff --git a/zh-cn/release-notes/OpenHarmony-v3.1.1-release.md b/zh-cn/release-notes/OpenHarmony-v3.1.1-release.md new file mode 100644 index 0000000000000000000000000000000000000000..4221bd6a6e856612083be928333d8f0c611a7bff --- /dev/null +++ b/zh-cn/release-notes/OpenHarmony-v3.1.1-release.md @@ -0,0 +1,142 @@ +# OpenHarmony 3.1.1 Release + + +## 版本概述 + +当前版本在OpenHarmony 3.1 Release的基础上，更新支持以下能力： + +**标准系统基础能力增强** + +系统服务管理能力增强，新增添加群组校验机制；电源管理新增支持亮度调节和电池信息查询；Misc软件服务补齐兼容http文件下载接口能力。 + +位置服务支持基本定位接口能力；窗口支持窗口属性设置；媒体补齐音频焦点、音频解码能力相关接口能力。 + +网络管理支持以太网连接，新增WebSocket JS API，兼容\@system.fetch和\@system.network接口能力。 + +**标准系统分布式能力增强** + +分布式数据管理支持兼容\@system.storage接口能力。 + +**标准系统应用程序框架能力增强** + +包管理支持查询指定应用是否安装；事件通知实现通知发送和取消的接口能力。 + +元能力支持FA模型支持查询/设置组件横竖屏状态、组件锁屏显示和组件启动亮屏，新增ANR(Application Not Response)、应用主线程卡死检测等DFX功能，完善部分FA卡片基础能力。 + +**标准系统应用能力增强** + +联系人支持第三方应用调用系统通话能力，提供用户基础通信能力。 + + +## 配套关系 + + **表1** 版本软件和工具配套关系 + +| 软件 | 版本 | 备注 | +| -------- | -------- | -------- | +| OpenHarmony | 3.1.1 Release | NA | +| SDK | Ohos_sdk 3.1.1 Release (API Version 8) | NA | +| HUAWEI DevEco Studio（可选） | 3.0 Beta3 for OpenHarmony | OpenHarmony应用开发推荐使用 | +| HUAWEI DevEco Device Tool（可选） | 3.0 Release | OpenHarmony智能设备集成开发环境推荐使用 | + + +## 源码获取 + + +### 前提条件 + +1. 注册码云gitee账号。 + +2. 注册码云SSH公钥，请参考[码云帮助中心](https://gitee.com/help/articles/4191)。 + +3. 安装[git客户端](https://gitee.com/link?target=https%3A%2F%2Fgit-scm.com%2Fbook%2Fzh%2Fv2%2F%25E8%25B5%25B7%25E6%25AD%25A5-%25E5%25AE%2589%25E8%25A3%2585-Git)和[git-lfs](https://gitee.com/vcs-all-in-one/git-lfs?_from=gitee_search#downloading)并配置用户信息。 + + ``` + git config --global user.name "yourname" + git config --global user.email "your-email-address" + git config --global credential.helper store + ``` + +4. 安装码云repo工具，可以执行如下命令。 + + ``` + curl -s https://gitee.com/oschina/repo/raw/fork_flow/repo-py3 > /usr/local/bin/repo #如果没有权限，可下载至其他目录，并将其配置到环境变量中chmod a+x /usr/local/bin/repo + pip3 install -i https://repo.huaweicloud.com/repository/pypi/simple requests + ``` + + +### 通过repo获取 + +**方式一（推荐）** + +通过repo + ssh 下载（需注册公钥，请参考[码云帮助中心](https://gitee.com/help/articles/4191)）。 + + +``` +repo init -u git@gitee.com:openharmony/manifest.git -b refs/tags/OpenHarmony-v3.1.1-Release --no-repo-verify +repo sync -c +repo forall -c 'git lfs pull' +``` + +**方式二** + +通过repo + https 下载。 + + +``` +repo init -u https://gitee.com/openharmony/manifest.git -b refs/tags/OpenHarmony-v3.1.1-Release --no-repo-verify +repo sync -c +repo forall -c 'git lfs pull' +``` + + +### 从镜像站点获取 + +*待补充* + + +## 更新说明 + +本版本在OpenHarmony 3.1 Release的基础上有如下变更。 + + +### 特性变更 + +**表3** 版本新增特性表 + + | 子系统名称 | 标准系统 | 轻量、小型系统 | +| -------- | -------- | -------- | +| 系统服务管理 | 新增添加群组校验机制。
主要涉及如下需求：
I52G5Q 添加群组校验机制 | NA | +| 电源管理 | 实现兼容亮度调节和电池信息查询API接口能力。
主要涉及如下需求：
I526UP 支持\@system.brightness亮度调节接口
I526UP 支持\@system.battery电池信息查询接口 | NA | +| 包管理 | 实现查询指定应用是否安装接口能力。
主要涉及如下需求：
I56EWD 支持对测试框架的配置
I55RZJ 查询指定应用是否安装 | NA | +| 位置服务 | 实现兼容基本定位API接口能力。
主要涉及如下需求：
I53WFP 支持基本定位能力，兼容system API | NA | +| 元能力 | 实现FA模型支持查询/设置组件横竖屏状态、组件锁屏显示和组件启动亮屏。
主要涉及如下需求：
I56EH7 FA模型支持查询/设置组件横竖屏状态
I50D5Y FA模型支持组件锁屏显示
I56EH7 FA模型支持组件启动亮屏
I55WB0 卡片数据支持携带图片
I55WB0 FA卡片能力补齐-formManager重构
I55WB0 FA卡片能力补齐-支持卡片状态查询
I55WB0 FA卡片能力补齐-支持删除无效卡片
I55WB0 FA卡片能力补齐-支持卡片可见状态与更新状态单独设置
I50D8H 支持拦截uncatchedexception
I50D91 支持ANR(Application Not Response)处理 | NA | +| 媒体 | 实现音频焦点、音频解码能力相关API接口能力。
主要涉及如下需求：
I56REO 音频部件焦点/设备接口OH补齐
I522W0 支持amr格式音频编码枚举类型 | NA | +| 窗口 | 支持对窗口属性进行设置。
主要涉及如下需求：
I56EH7 支持窗口属性设置 | NA | +| 网络管理 | 实现兼容WebSocket、fetch等API接口能力，支持以太网连接。
主要涉及如下需求：
I53CKH 支持兼容\@system.fetch
I53CJX 支持兼容\@system.network
I53CKT 支持WebSocket
I580PC 支持以太网连接 | NA | +| Misc软件服务 | 实现兼容http文件下载API接口能力。
主要涉及如下需求：
I56Q4X 支持文件下载接口 | NA | +| 事件通知 | 实现通知发送和取消的API接口能力。
主要涉及如下需求：
I50EEW 通知发送和取消功能的接口能力补齐 | NA | +| 分布式数据管理 | 实现兼容\@system.storage API接口能力。
主要涉及如下需求：
I56RF3     支持\@system.storage接口 | NA | +| 启动恢复 | 实现兼容\@system.device API接口能力。
主要涉及如下需求：
I56GBS 支持\@system.device相关API | NA | +| 应用 | 联系人支持第三方应用调用系统通话能力，提供用户基础通信能力。
主要涉及如下需求：
I58ZQ4 联系人支持第三方应用调用系统通话能力 | NA | + +API变更 + + +3.1.1 Release对比3.1 Release API接口无变更。 + + + +### 芯片及开发板适配 + +芯片及开发板适配状态请参考[SIG-Devboard](https://gitee.com/openharmony/community/blob/master/sig/sig-devboard/sig_devboard_cn.md)信息。 + + +## 修复缺陷列表 + +*待补充* + + +## 遗留缺陷列表 + +*待补充* diff --git a/zh-cn/release-notes/Readme.md b/zh-cn/release-notes/Readme.md index 89084fe567535e0a0a190bbeb696d25a3bde438e..c22ebd5c948899460dfa4a590d4fe3c7cc14ed6d 100644 --- a/zh-cn/release-notes/Readme.md +++ b/zh-cn/release-notes/Readme.md @@ -1,5 +1,6 @@ # OpenHarmony Release Notes ## OpenHarmony 3.x Releases +- [OpenHarmony v3.1.1 Release (2022-05-31)](OpenHarmony-v3.1.1-release.md) - [OpenHarmony v3.1 Release (2022-03-30)](OpenHarmony-v3.1-release.md) - [OpenHarmony v3.1 Beta (2021-12-31)](OpenHarmony-v3.1-beta.md) - [OpenHarmony v3.0.2 LTS (2022-03-18)](OpenHarmony-v3.0.2-LTS.md) diff --git a/zh-cn/website.md b/zh-cn/website.md index a53ff49cfcf3191b0bbd8ca3531ff3572fcd3088..888150a520b895c7918e7fb2575a06a38a1e0b2b 100644 --- a/zh-cn/website.md +++ b/zh-cn/website.md @@ -4,7 +4,7 @@ - [术语](glossary.md) - 版本说明 - OpenHarmony 3.x Releases - + - [OpenHarmony v3.1.1 Release (2022-05-31)](release-notes/OpenHarmony-v3.1.1-release.md) - [OpenHarmony v3.1 Release (2022-03-30)](release-notes/OpenHarmony-v3.1-release.md) - [OpenHarmony v3.1 Beta (2021-12-31)](release-notes/OpenHarmony-v3.1-beta.md) - [OpenHarmony v3.0.1 LTS (2022-01-12)](release-notes/OpenHarmony-v3.0.1-LTS.md)