Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
未验证 提交 dcfc7f10 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!4664 RN新增+应用沙箱路径描述修改+dfx指南修改 

Merge pull request !4664 from zengyawen/OpenHarmony-3.2-Beta1
上级 dabcf7f7 f87825fb
展开全部 隐藏空白更改
内联 并排
Showing with 468 addition and 256 deletion
zh-cn/application-dev/dfx/hiappevent-guidelines.md
浏览文件 @ dcfc7f10
......@@ -17,7 +17,7 @@
| write(string eventName, EventType type, object keyValues, AsyncCallback\<void> callback): void | void | 应用事件异步打点方法，使用callback方式作为异步回调。 |
| write(string eventName, EventType type, object keyValues): Promise\<void> | Promise\<void> | 应用事件异步打点方法，使用promise方式作为异步回调。 |
当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](hiappevent-overview.md#事件校验结果码)。
当采用callback作为异步回调时，可以在callback中进行下一步处理。当采用Promise对象返回时，可以在Promise对象中类似地处理接口返回值。具体结果码说明见[事件校验结果码](#事件校验结果码)。
**打点配置接口功能介绍：**
......@@ -25,6 +25,24 @@
| ------------------------------ | ------- | ------------------------------------------------------------ |
| configure(ConfigOption config) | boolean | 应用事件打点配置方法，可以对打点功能进行自定义配置。返回true表示配置成功，false表示配置失败。 |
### 事件校验结果码
| 错误码 | 原因 | 校验规则 | 处理结果 |
| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| 0 | 无 | 事件校验成功 | 事件正常打点。 |
| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。<br>只由以下字符组成：0-9、a-z、_。<br/>非数字以及下划线开头。 | 忽略该事件，不执行打点。 |
| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。<br/>事件类型参数必须为number类型。<br/>keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 |
| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 |
| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 |
| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。<br/>只由以下字符组成：0-9、a-z、_。<br/>非数字以及下划线开头。<br/>非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 |
| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 |
| 3 | 无效的value参数类型 | value参数只支持以下类型：<br/>boolean、number、string、Array[基本类型]。<br/> | 忽略该键值对参数后，继续执行打点。 |
| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 |
| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 |
| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 |
| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。<br/>List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 |
## 开发步骤
在应用启动执行页面加载后，执行一个应用事件打点，用于记录应用的初始页面加载事件。
......
zh-cn/application-dev/dfx/hiappevent-overview.md
浏览文件 @ dcfc7f10
......@@ -6,21 +6,4 @@ HiAppEvent提供了应用事件打点接口，为应用提供事件打点的功
HiAppEvent模块支持应用事件业务的开发，提供应用事件相关的功能，主要包括应用事件落盘、查询历史应用事件数据等功能。
**打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。
## 事件校验结果码
| 错误码 | 原因 | 校验规则 | 处理结果 |
| ------ | --------------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| 0 | 无 | 事件校验成功 | 事件正常打点。 |
| -1 | 无效的事件名称 | 非空且长度在48个字符以内（含）。<br>只由以下字符组成：0-9、a-z、_。<br/>非数字以及下划线开头。 | 忽略该事件，不执行打点。 |
| -2 | 无效的事件基本参数类型 | 事件名称参数必须为string。<br/>事件类型参数必须为number类型。<br/>keyValues参数必须为object类型。 | 忽略该事件，不执行打点。 |
| -99 | 应用打点功能被关闭 | 应用打点功能被关闭。 | 忽略该事件，不执行打点。 |
| -100 | 未知错误 | 无。 | 忽略该事件，不执行打点。 |
| 1 | 无效的key参数名称 | 非空且长度在16个字符以内（含）。<br/>只由以下字符组成：0-9、a-z、_。<br/>非数字以及下划线开头。<br/>非下划线结尾。 | 忽略该键值对参数后，继续执行打点。 |
| 2 | 无效的key参数类型 | Key参数必须为字符串类型。 | 忽略该键值对参数后，继续执行打点。 |
| 3 | 无效的value参数类型 | value参数只支持以下类型：<br/>boolean、number、string、Array[基本类型]。<br/> | 忽略该键值对参数后，继续执行打点。 |
| 4 | value参数值过长 | 参数值长度必须在8*1024个字符以内（含）。 | 忽略该键值对参数后，继续执行打点。 |
| 5 | key-value参数对数过多 | key-value参数对数必须在32对以内（含）。 | 忽略后面多余的键值对参数后，继续执行打点。 |
| 6 | List类型的value参数容量过大 | List类型的value参数容量必须在100个以内（含）。 | 对List进行截断（只保留前100个元素）后，继续执行打点。 |
| 7 | 无效的List类型value参数 | List的泛型类型只能为基本类型。<br/>List内的参数必须为同一类型。 | 忽略该键值对参数后，继续执行打点。 |
\ No newline at end of file
**打点**：记录由用户操作引起的变化，提供业务数据信息，以供开发、产品、运维分析。
\ No newline at end of file
zh-cn/application-dev/dfx/hitracemeter-overview.md
浏览文件 @ dcfc7f10
......@@ -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类别选项指定的跟踪数据。
## 运作机制
......
zh-cn/application-dev/reference/apis/Readme-CN.md
浏览文件 @ dcfc7f10
......@@ -122,10 +122,10 @@
- [@ohos.environment (目录环境能力)](js-apis-environment.md)
- [@ohos.fileio (文件管理)](js-apis-fileio.md)
- [@ohos.fileManager (公共文件访问与管理)](js-apis-filemanager.md)
- [@ohos.securityLabel (数据标签)](js-apis-securityLabel.md)
- [@ohos.statfs (statfs)](js-apis-statfs.md)
- [@ohos.storageStatistics (应用空间统计)](js-apis-storage-statistics.md)
- [@ohos.volumeManager (卷管理)](js-apis-volumemanager.md)
- [@ohos.securityLabel (数据标签)](js-apis-securityLabel.md)
- 电话服务
- [@ohos.contact (联系人)](js-apis-contact.md)
......
zh-cn/application-dev/reference/apis/js-apis-document.md
浏览文件 @ dcfc7f10
# 文件交互
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：**
- 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
- 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。
> - 本模块首批接口从API version 6开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
> - 本模块接口后续将废弃。不建议在OpenHarmony使用以下接口，调用以下接口将抛出异常。
## 导入模块
......
zh-cn/application-dev/reference/apis/js-apis-image.md
浏览文件 @ dcfc7f10
......@@ -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.createImageSource<sup>7+</sup>
......
zh-cn/application-dev/reference/apis/js-apis-medialibrary.md
浏览文件 @ dcfc7f10
......@@ -2237,11 +2237,11 @@ async function example() {
**系统能力：** 以下各项对应的系统能力均为SystemCapability.Multimedia.MediaLibrary.Core
| 名称 | 类型 | 必填 | 描述 |
| ------------ | ------ | ---- | ---------------------------------------- |
| src | string | 是 | 应用本地文件绝对路径。 |
| mimeType | string | 是 | 媒体MIME（Multipurpose&nbsp;Internet&nbsp;Mail&nbsp;Extensions）类型。<br/>包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 |
| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。 <br/> image类型默认路径Pictures/ <br/> video类型默认路径Videos/ <br/> audio类型默认路径Audios/ <br/> file类型默认路径Documents/ 。 |
| 名称 | 类型 | 必填 | 描述 |
| ------------ | ------ | ---- | ------------------------------------------------------------ |
| src | string | 是 | 本地文件应用沙箱路径。 |
| mimeType | string | 是 | 媒体MIME（Multipurpose&nbsp;Internet&nbsp;Mail&nbsp;Extensions）类型。<br/>包括：'image/\*'、'video/\*'、'audio/\*'、 'file\*'。 |
| relativePath | string | 否 | 自定义媒体资源保存位置，例：Pictures/ 不填则保存到默认路径。 <br/> image类型默认路径Pictures/ <br/> video类型默认路径Videos/ <br/> audio类型默认路径Audios/ <br/> file类型默认路径Documents/ 。 |
## MediaSelectOption<sup>(deprecated)</sup>
......
zh-cn/application-dev/reference/apis/js-apis-securityLabel.md
浏览文件 @ dcfc7f10
......@@ -13,11 +13,11 @@ import securityLabel from '@ohos.securityLabel';
## 使用说明
使用该功能模块对文件/目录进行操作前，需要先获取其绝对路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。
使用该功能模块对文件/目录进行操作前，需要先获取其应用沙箱路径，获取方式及其接口用法请参考：[Context模块的接口getOrCreateLocalDir](js-apis-Context.md)。
“文件/目录绝对路径”=“应用目录路径”+“文件/目录名”
“文件/目录应用沙箱路径”=“应用目录路径”+“文件/目录名”
通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在绝对路径为：
通过上述接口获取到应用目录路径dir，文件名为“xxx.txt”，文件所在的应用沙箱路径为：
```js
let path = dir + "/xxx.txt";
......
zh-cn/application-dev/reference/apis/js-apis-statfs.md
浏览文件 @ dcfc7f10
......@@ -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";
......
zh-cn/release-notes/OpenHarmony-v3.2-beta1.md 0 → 100644
浏览文件 @ dcfc7f10
此差异已折叠。
zh-cn/release-notes/Readme.md
浏览文件 @ dcfc7f10
# OpenHarmony Release Notes
## OpenHarmony 3.x Releases
- [OpenHarmony v3.2 Beta1 (2022-05-31)](OpenHarmony-v3.2-beta1.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.3 LTS (2022-04-08)](OpenHarmony-v3.0.3-LTS.md)
......
zh-cn/website.md
浏览文件 @ dcfc7f10
......@@ -5,6 +5,7 @@
- 版本说明
- OpenHarmony 3.x Releases
- [OpenHarmony v3.2 Beta1 (2022-05-31)](release-notes/OpenHarmony-v3.2-beta1.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.3 LTS (2022-04-08)](release-notes/OpenHarmony-v3.0.3-LTS.md)
......@@ -23,7 +24,7 @@
- [OpenHarmony 1.1.1 LTS (2021-06-22)](release-notes/OpenHarmony-1-1-1-LTS.md)
- [OpenHarmony 1.1.0 LTS (2021-04-01)](release-notes/OpenHarmony-1-1-0-LTS.md)
- [OpenHarmony 1.0 (2020-09-10)](release-notes/OpenHarmony-1-0.md)
- 贡献
- [参与贡献](contribute/参与贡献.md)
- [行为准则](contribute/行为准则.md)
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或