Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Tonvia
Docs
提交
60119fbc
D
Docs
项目概览
Tonvia
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
60119fbc
编写于
1月 30, 2023
作者:
M
marui
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
添加无障碍扩展服务开发指南
Signed-off-by:
N
marui
<
marui74@huawei.com
>
上级
a23cb57c
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
124 addition
and
0 deletion
+124
-0
zh-cn/application-dev/application-models/accessibilityextensionability.md
...n-dev/application-models/accessibilityextensionability.md
+124
-0
未找到文件。
zh-cn/application-dev/application-models/accessibilityextensionability.md
0 → 100644
浏览文件 @
60119fbc
# AccessibilityExtensionAbility开发指南
AccessibilityExtensionAbility基于ExtensionAbility框架,提供无障碍扩展服务,开发者可以基于AccessibilityExtensionAbility模板开发自己的辅助功能应用,协助用户完成一些快捷的交互过程。
> **环境要求**
>
> IDE: DevEco Studio 3.0 Beta3 (3.0.0.900)及以后版本
>
> SDK: API Version 9 及以后版本
>
> Model: Stage
本文档将从以下场景来介绍AccessibilityExtensionAbility的基本开发:
-
[
如何创建一个无障碍扩展服务
](
#如何创建一个无障碍扩展服务
)
-
[
如何处理一个无障碍事件
](
#如何处理一个无障碍事件
)
-
[
如何声明无障碍扩展服务具备的能力
](
#如何声明无障碍扩展服务具备的能力
)
-
[
如何开启自定义的无障碍扩展服务
](
#如何开启自定义的无障碍扩展服务
)
-
[
相关示例
](
#相关示例
)
## 如何创建一个无障碍扩展服务
开发者在创建一个无障碍扩展服务时,如工程满足环境要求,开发者可自主选择是否跳过创建工程步骤,在已有工程中新增无障碍扩展服务。
### 创建工程
如需新增独立的无障碍扩展服务应用,可按以下步骤进行。在DevEco Studio中新建一个工程,具体步骤如下:
1.
在DevEco Studio的左上角标签栏,选择
`File -> New -> Create Project`
新建一个工程;
2.
根据工程创建向导,选择
`OpenHarmony`
标签页,选择
`Empty Ability`
模板,点击Next,进入项目详细配置页;
3.
选择项目类型为Application,Compile API(高版本为Compile SDK)为9,Model为
`Stage`
,然后点击Finish完成工程创建。
### 新建AccessibilityExtAbility文件
在已创建工程的ets文件夹下创建AccessibilityExtAbility文件夹,在该文件夹下创建AccessibilityExtAbility.ts文件,在新增的文件中加入以下代码:
```
typescript
import
AccessibilityExtensionAbility
from
'
@ohos.application.AccessibilityExtensionAbility
'
;
class
AccessibilityExtAbility
extends
AccessibilityExtensionAbility
{
onConnect
()
{
console
.
log
(
'
AccessibilityExtAbility onConnect
'
);
}
onDisconnect
()
{
console
.
log
(
'
AccessibilityExtAbility onDisconnect
'
);
}
onAccessibilityEvent
(
accessibilityEvent
)
{
console
.
log
(
'
AccessibilityExtAbility onAccessibilityEvent:
'
+
JSON
.
stringify
(
accessibilityEvent
));
}
}
export
default
AccessibilityExtAbility
;
```
其中,主要定义了以下接口:
| 接口 | 描述 |
| ---- | ---- |
| onConnect(): void | 当扩展服务连接时回调 |
| onDisconnect(): void | 当扩展服务断开时回调 |
| onAccessibilityEvent(event: AccessibilityEvent): void | 当无障碍事件发生时回调 |
## 如何处理一个无障碍事件
相关无障碍事件可以在
`onAccessibilityEvent()`
方法中进行业务逻辑处理,具体事件可参考
[
AccessibilityEvent
](
../reference/apis/js-apis-application-accessibilityExtensionAbility.md#accessibilityevent
)
。此处以事件
`pageStateUpdate`
为例:
```
typescript
onAccessibilityEvent
(
accessibilityEvent
)
{
console
.
log
(
'
AccessibilityExtAbility onAccessibilityEvent:
'
+
JSON
.
stringify
(
accessibilityEvent
));
if
(
accessibilityEvent
.
eventType
===
'
pageStateUpdate
'
)
{
console
.
log
(
'
AccessibilityExtAbility onAccessibilityEvent: pageStateUpdate
'
);
// TODO: 自定义相关逻辑开发
}
}
```
此外,也可在相应的无障碍事件中,使用
[
辅助功能扩展上下文(AccessibilityExtensionContext)
](
../reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
)
提供的接口进行扩展开发,包括允许配置辅助应用关注信息类型、查询节点信息、手势注入等。
## 如何声明无障碍扩展服务具备的能力
在完成自定义无障碍扩展服务的逻辑开发后,还需要在工程中Module对应的module.json5文件中加入新增扩展服务的配置信息,其中
`srcEntrance`
标签为
`extensionAbility`
对应的路径。需要注意的一点是配置信息中的type标签要按照与无障碍子系统的约定进行配置,固定为
`accessibility`
,否则将无法正常连接。
```
json
"extensionAbilities"
:
[
{
"name"
:
"AccessibilityExtAbility"
,
"srcEntrance"
:
"./ets/AccessibilityExtAbility/AccessibilityExtAbility.ts"
,
"label"
:
"$string:MainAbility_label"
,
"description"
:
"$string:MainAbility_desc"
,
"type"
:
"accessibility"
,
"metadata"
:
[
{
"name"
:
"ohos.accessibleability"
,
"resource"
:
"$profile:accessibility_config"
}
]
}
]
```
另外,配置信息中的
`accessibility_config`
为无障碍扩展服务的具体配置,需要在
`resources/profile/`
下新建
`accessibility_config.json`
文件,在该文件中声明此无障碍扩展服务具备的
[
能力类型
](
../reference/apis/js-apis-accessibility.md#capability
)
:
```
json
{
"accessibilityCapabilities"
:
[
"retrieve"
,
"gesture"
]
}
```
## 如何开启自定义的无障碍扩展服务
目前设置中尚未开放无障碍扩展服务开启关闭功能,需要使用命令行进行开启关闭。
-
开启命令:
`accessibility enable -a AccessibilityExtAbility -b com.example.demo -c rg`
-
关闭命令:
`accessibility disable -a AccessibilityExtAbility -b com.example.demo`
其中,
`AccessibilityExtAbility`
为自定义的无障碍扩展服务名,
`com.example.demo`
为bundleName,
`rg`
为无障碍扩展服务具体的类型(其中,r为
`retrieve`
的首字母,其余同理)。
若开启或关闭成功,则会打印
`enable ability successfully`
或
`disable ability successfully`
。
## 相关示例
针对AccessibilityExtensionAbility开发,有以下相关示例可供参考:
[
AccessibilityExtAbility的创建和使用(ArkTS)(API 9)(Full SDK)
](
https://gitee.com/openharmony/applications_app_samples/tree/master/ability/AccessibilityExtAbility
)
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录