mirror of
https://gitee.com/openharmony/accessibility
synced 2024-11-27 00:51:07 +00:00
fix README
Signed-off-by: laiguizhong <laiguizhong@huawei.com>
This commit is contained in:
parent
be4596c558
commit
83fcdd6b00
36
README.en.md
36
README.en.md
@ -1,36 +0,0 @@
|
||||
# accessibility
|
||||
|
||||
#### Description
|
||||
{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}
|
||||
|
||||
#### Software Architecture
|
||||
Software architecture description
|
||||
|
||||
#### Installation
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Instructions
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### Contribution
|
||||
|
||||
1. Fork the repository
|
||||
2. Create Feat_xxx branch
|
||||
3. Commit your code
|
||||
4. Create Pull Request
|
||||
|
||||
|
||||
#### Gitee Feature
|
||||
|
||||
1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee blog [blog.gitee.com](https://blog.gitee.com)
|
||||
3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
|
||||
4. The most valuable open source project [GVP](https://gitee.com/gvp)
|
||||
5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
|
||||
6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
39
README.md
39
README.md
@ -1,39 +0,0 @@
|
||||
# accessibility
|
||||
|
||||
#### 介绍
|
||||
{**以下是 Gitee 平台说明,您可以替换此简介**
|
||||
Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台
|
||||
无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
|
||||
|
||||
#### 软件架构
|
||||
软件架构说明
|
||||
|
||||
|
||||
#### 安装教程
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### 使用说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
|
||||
#### 参与贡献
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 新建 Feat_xxx 分支
|
||||
3. 提交代码
|
||||
4. 新建 Pull Request
|
||||
|
||||
|
||||
#### 特技
|
||||
|
||||
1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
|
||||
2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
|
||||
3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
|
||||
4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目
|
||||
5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
|
||||
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
|
73
README_zh.md
73
README_zh.md
@ -1,6 +1,75 @@
|
||||
# XXX系统
|
||||
# 无障碍软件服务子系统
|
||||
# 简介<a name="intro"></a>
|
||||
|
||||
## 简介
|
||||
**无障碍框架**提供在应用程序和辅助应用之间交换信息的标准机制,支持开发辅助应用增强无障碍功能体验。
|
||||
|
||||
![](./figures/AccessibilityFramework.png)
|
||||
|
||||
# 目录<a name="files"></a>
|
||||
|
||||
```
|
||||
├── frameworks
|
||||
│ ├── aafwk # AccessibleAbility Kit实现代码
|
||||
│ └── asacfwk # AccessibleAbilityClient Kit实现代码
|
||||
├── interfaces
|
||||
│ ├── innerkits # AccessibleAbility 和 AccessibleAbilityClient 的子系统接口
|
||||
│ └── kits # AccessibleAbility 和 AccessibleAbilityClient 的开发者接口
|
||||
├── services
|
||||
│ └── aams # AccessibleAbility 管理服务框架代码
|
||||
├── test # 测试目录
|
||||
└── util # 工具类目录
|
||||
```
|
||||
|
||||
# 使用说明<a name="usage"></a>
|
||||
|
||||
### isOpenAccessibility(): Promise\<boolean>
|
||||
|
||||
检查是否启用了辅助功能。
|
||||
|
||||
- 参数:
|
||||
|
||||
无
|
||||
|
||||
- 返回值:
|
||||
|
||||
| 类型 | 说明 |
|
||||
| --- | --- |
|
||||
| Promise\<boolean> | 以Promise形式返回结果,如果辅助功能已启用,则返回true;如果辅助功能未启用,则返回false。 |
|
||||
|
||||
- 示例
|
||||
|
||||
```js
|
||||
accessibility.isOpenAccessibility()
|
||||
.then((data) => {
|
||||
console.info('success data:isOpenAccessibility : ' + JSON.stringify(data))
|
||||
}).catch((error) => {
|
||||
console.error('failed to isOpenAccessibility because ' + JSON.stringify(error));
|
||||
})
|
||||
```
|
||||
|
||||
### sendEvent(event: EventInfo): Promise\<void>
|
||||
|
||||
发送无障碍事件。
|
||||
|
||||
- 参数:
|
||||
|
||||
| 参数名 | 参数类型 | 必填 | 说明 |
|
||||
| --- | --- | --- | --- |
|
||||
| event | EventInfo | 是 | 辅助事件对象。 |
|
||||
|
||||
- 返回值:
|
||||
|
||||
| 类型 | 说明 |
|
||||
| --- | --- |
|
||||
| Promise<void> | 以Promise形式返回结果,如果发送无障碍事件成功,则data有数据返回;如果发送无障碍事件失败,则err有数据返回。 |
|
||||
|
||||
- 示例
|
||||
|
||||
```js
|
||||
accessibility.sendEvent(this.eventInfo)
|
||||
.then((data) => {
|
||||
console.info('success data:sendEvent : ' + JSON.stringify(data))
|
||||
}).catch((error) => {
|
||||
console.error('failed to sendEvent because ' + JSON.stringify(error));
|
||||
})
|
||||
```
|
||||
|
BIN
figures/AccessibilityFramework.png
Normal file
BIN
figures/AccessibilityFramework.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 112 KiB |
Loading…
Reference in New Issue
Block a user