Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

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

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

Merge pull request !4663 from zengyawen/OpenHarmony-3.1-Release
上级 4bdb955f 643bdfc7
展开全部 隐藏空白更改
内联 并排
Showing with 396 addition and 252 deletion
zh-cn/application-dev/dfx/hiappevent-guidelines.md
浏览文件 @ d688bdb7
......@@ -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,23 @@
| ------------------------------ | ------- | ------------------------------------------------------------ |
| 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
浏览文件 @ d688bdb7
......@@ -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
浏览文件 @ d688bdb7
......@@ -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/js-apis-document.md
浏览文件 @ d688bdb7
# 文件交互
> ![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
浏览文件 @ d688bdb7
......@@ -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
浏览文件 @ d688bdb7
......@@ -2227,11 +2227,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-statfs.md
浏览文件 @ d688bdb7
......@@ -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.1.1-release.md 0 → 100644
浏览文件 @ d688bdb7
# 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&nbsp;Release | NA |
| SDK | Ohos_sdk&nbsp;3.1.1&nbsp;Release&nbsp;(API&nbsp;Version&nbsp;8) | NA |
| HUAWEI&nbsp;DevEco&nbsp;Studio（可选） | 3.0&nbsp;Beta3&nbsp;for&nbsp;OpenHarmony | OpenHarmony应用开发推荐使用 |
| HUAWEI&nbsp;DevEco&nbsp;Device&nbsp;Tool（可选） | 3.0&nbsp;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** 版本新增特性表
| 子系统名称 | 标准系统 | 轻量、小型系统 |
| -------- | -------- | -------- |
| 系统服务管理 | 新增添加群组校验机制。<br/>主要涉及如下需求：<br/>I52G5Q&nbsp;添加群组校验机制 | NA |
| 电源管理 | 实现兼容亮度调节和电池信息查询API接口能力。<br/>主要涉及如下需求：<br/>I526UP&nbsp;支持\@system.brightness亮度调节接口<br/>I526UP&nbsp;支持\@system.battery电池信息查询接口 | NA |
| 包管理 | 实现查询指定应用是否安装接口能力。<br/>主要涉及如下需求：<br/>I56EWD&nbsp;支持对测试框架的配置<br/>I55RZJ&nbsp;查询指定应用是否安装 | NA |
| 位置服务 | 实现兼容基本定位API接口能力。<br/>主要涉及如下需求：<br/>I53WFP&nbsp;支持基本定位能力，兼容system&nbsp;API | NA |
| 元能力 | 实现FA模型支持查询/设置组件横竖屏状态、组件锁屏显示和组件启动亮屏。<br/>主要涉及如下需求：<br/>I56EH7&nbsp;FA模型支持查询/设置组件横竖屏状态<br/>I50D5Y&nbsp;FA模型支持组件锁屏显示<br/>I56EH7&nbsp;FA模型支持组件启动亮屏<br/>I55WB0&nbsp;卡片数据支持携带图片<br/>I55WB0&nbsp;FA卡片能力补齐-formManager重构<br/>I55WB0&nbsp;FA卡片能力补齐-支持卡片状态查询<br/>I55WB0&nbsp;FA卡片能力补齐-支持删除无效卡片<br/>I55WB0&nbsp;FA卡片能力补齐-支持卡片可见状态与更新状态单独设置<br/>I50D8H&nbsp;支持拦截uncatchedexception<br/>I50D91&nbsp;支持ANR(Application&nbsp;Not&nbsp;Response)处理 | NA |
| 媒体 | 实现音频焦点、音频解码能力相关API接口能力。<br/>主要涉及如下需求：<br/>I56REO&nbsp;音频部件焦点/设备接口OH补齐<br/>I522W0&nbsp;支持amr格式音频编码枚举类型 | NA |
| 窗口 | 支持对窗口属性进行设置。<br/>主要涉及如下需求：<br/>I56EH7&nbsp;支持窗口属性设置 | NA |
| 网络管理 | 实现兼容WebSocket、fetch等API接口能力，支持以太网连接。<br/>主要涉及如下需求：<br/>I53CKH&nbsp;支持兼容\@system.fetch<br/>I53CJX&nbsp;支持兼容\@system.network<br/>I53CKT&nbsp;支持WebSocket<br/>I580PC&nbsp;支持以太网连接 | NA |
| Misc软件服务 | 实现兼容http文件下载API接口能力。<br/>主要涉及如下需求：<br/>I56Q4X&nbsp;支持文件下载接口 | NA |
| 事件通知 | 实现通知发送和取消的API接口能力。<br/>主要涉及如下需求：<br/>I50EEW&nbsp;通知发送和取消功能的接口能力补齐 | NA |
| 分布式数据管理 | 实现兼容\@system.storage&nbsp;API接口能力。<br/>主要涉及如下需求：<br/>I56RF3&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;支持\@system.storage接口 | NA |
| 启动恢复 | 实现兼容\@system.device&nbsp;API接口能力。<br/>主要涉及如下需求：<br/>I56GBS&nbsp;支持\@system.device相关API | NA |
| 应用 | 联系人支持第三方应用调用系统通话能力，提供用户基础通信能力。<br/>主要涉及如下需求：<br/>I58ZQ4&nbsp;联系人支持第三方应用调用系统通话能力 | 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)信息。
## 修复缺陷列表
*待补充*
## 遗留缺陷列表
*待补充*
zh-cn/release-notes/Readme.md
浏览文件 @ d688bdb7
# 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)
......
zh-cn/website.md
浏览文件 @ d688bdb7
......@@ -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)
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或