Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
d653d420
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
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,发现更多精彩内容 >>
未验证
提交
d653d420
编写于
3月 27, 2023
作者:
O
openharmony_ci
提交者:
Gitee
3月 27, 2023
浏览文件
操作
浏览文件
下载
差异文件
!16423 无障碍软件服务开发指南修改
Merge pull request !16423 from ranzhiqiang/master
上级
e1237224
1a3cf46e
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
351 addition
and
351 deletion
+351
-351
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
...n/application-dev/reference/apis/js-apis-accessibility.md
+200
-200
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
...apis/js-apis-application-accessibilityExtensionAbility.md
+17
-17
zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
...s-apis-inner-application-accessibilityExtensionContext.md
+134
-134
未找到文件。
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @
d653d420
...
...
@@ -18,9 +18,9 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| -------
-
| -------- |
| enable | 辅助应用已启用。 |
| 名称
| 描述
|
| ------- | -------- |
| enable
| 辅助应用已启用。 |
| disable | 辅助应用已禁用。 |
| install | 辅助应用已安装。 |
...
...
@@ -30,13 +30,13 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| --------
|
-------- |
| audible | 表示具有听觉反馈。 |
| generic | 表示具有通用反馈。 |
| haptic | 表示具有触觉反馈。 |
| spoken | 表示具有语音反馈。 |
| visual | 表示具有视觉反馈。 |
| 名称
| 描述
|
| --------
-------- | -
-------- |
| audible
| 表示具有听觉反馈。 |
| generic
| 表示具有通用反馈。 |
| haptic
| 表示具有触觉反馈。 |
| spoken
| 表示具有语音反馈。 |
| visual
| 表示具有视觉反馈。 |
| all
<sup>
9+
</sup>
| 表示以上所有类别。 |
## AccessibilityAbilityInfo
...
...
@@ -47,16 +47,16 @@ import accessibility from '@ohos.accessibility';
### 属性
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| id
| string | 是 | 否
| ability
id。 |
| name
| string | 是 | 否 | ability 名。
|
| bundleName
| string | 是 | 否 | Bundle名称。
|
| targetBundleNames
<sup>
9+
</sup>
| Array
<
string
>
| 是 | 否 | 关注的目标Bundle名称。
|
| abilityTypes
| Array
<
[AbilityType](#abilitytype)
>
| 是 | 否 | 辅助应用类型。
|
| capabilities
| Array
<
[Capability](#capability)
>
| 是 | 否 | 辅助应用能力列表。
|
| description
| string | 是 | 否 | 辅助应用描述。
|
| eventTypes
| Array
<
[EventType](#eventtype)
>
| 是 | 否 | 辅助应用关注的无障碍事件列表。
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
---------------------- | ---------------------------------------- | ---- | ---- | --------
-------- |
| id
| string | 是 | 否
| ability
id。 |
| name
| string | 是 | 否 | ability 名。
|
| bundleName
| string | 是 | 否 | Bundle名称。
|
| targetBundleNames
<sup>
9+
</sup>
| Array
<
string
>
| 是 | 否 | 关注的目标Bundle名称。
|
| abilityTypes
| Array
<
[AbilityType](#abilitytype)
>
| 是 | 否 | 辅助应用类型。
|
| capabilities
| Array
<
[Capability](#capability)
>
| 是 | 否 | 辅助应用能力列表。
|
| description
| string | 是 | 否 | 辅助应用描述。
|
| eventTypes
| Array
<
[EventType](#eventtype)
>
| 是 | 否 | 辅助应用关注的无障碍事件列表。
|
## Action
...
...
@@ -64,24 +64,24 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| --------
|
-------- |
| click
| 表示点击操作。
|
| longClick
| 表示长按操作。
|
| scrollForward
| 表示向前滚动操作
。 |
| scrollBackward
| 表示向后滚动操作
。 |
| focus
| 表示获得焦点操作
。 |
| clearFocus
| 表示清除焦点操作
。 |
| clearSelection
| 表示清除选择操作
。 |
| accessibilityFocus
| 表示获得无障碍焦点操作。
|
| clearAccessibilityFocus | 表示清除无障碍焦点操作。 |
| cut
| 表示剪切操作。
|
| copy
| 表示复制操作。
|
| paste
| 表示粘贴操作。
|
| select
| 表示选择操作。
|
| setText
| 表示设置文本操作
。 |
| delete
| 表示删除操作。
|
| setSelection
| 表示选择操作。
|
| 名称
| 描述
|
| --------
--------------- | ----------
-------- |
| click
| 表示点击操作。
|
| longClick
| 表示长按操作。
|
| scrollForward
| 表示向前滚动操作;当前版本暂不支持
。 |
| scrollBackward
| 表示向后滚动操作;当前版本暂不支持
。 |
| focus
| 表示获得焦点操作;当前版本暂不支持
。 |
| clearFocus
| 表示清除焦点操作;当前版本暂不支持
。 |
| clearSelection
| 表示清除选择操作;当前版本暂不支持
。 |
| accessibilityFocus
| 表示获得无障碍焦点操作。
|
| clearAccessibilityFocus | 表示清除无障碍焦点操作。
|
| cut
| 表示剪切操作;当前版本暂不支持。
|
| copy
| 表示复制操作;当前版本暂不支持。
|
| paste
| 表示粘贴操作;当前版本暂不支持。
|
| select
| 表示选择操作,当前版本暂不支持。
|
| setText
| 表示设置文本操作;当前版本暂不支持
。 |
| delete
| 表示删除操作;当前版本暂不支持。
|
| setSelection
| 表示选择操作;当前版本暂不支持。
|
## Capability
...
...
@@ -89,13 +89,13 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| --------
|
-------- |
| retrieve
| 具有检索窗口内容的能力。
|
| touchGuide
| 具有触摸探索模式的能力。
|
| keyEventObserver | 具有过滤按键事件的能力。 |
| zoom
| 具有控制显示放大的能力
。 |
| gesture
| 具有执行手势动作的能力。
|
| 名称
| 描述
|
| --------
-------- | -------------
-------- |
| retrieve
| 具有检索窗口内容的能力。
|
| touchGuide
| 具有触摸探索模式的能力。
|
| keyEventObserver | 具有过滤按键事件的能力。
|
| zoom
| 具有控制显示放大的能力;当前版本暂不支持
。 |
| gesture
| 具有执行手势动作的能力。
|
## CaptionsFontEdgeType<sup>8+</sup>
...
...
@@ -103,12 +103,12 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称
| 描述
|
| --------
| ---
----- |
| none
| 无效果。
|
| raised | 凸起效果。 |
| depressed | 凹陷效果。 |
| uniform | 轮廓效果。 |
| 名称
| 描述
|
| --------
-- |
----- |
| none
| 无效果。
|
| raised
| 凸起效果。 |
| depressed
| 凹陷效果。 |
| uniform
| 轮廓效果。 |
| dropShadow | 阴影效果。 |
## CaptionsFontFamily<sup>8+</sup>
...
...
@@ -117,16 +117,16 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称
| 描述
|
| --------
|
-------- |
| default
| 默认字体。
|
| monospacedSerif
| 等宽 Serif 字体。
|
| serif
| Serif 字体。
|
| 名称
| 描述
|
| --------
----------- | ---------
-------- |
| default
| 默认字体。
|
| monospacedSerif
| 等宽 Serif 字体。
|
| serif
| Serif 字体。
|
| monospacedSansSerif | 等宽 Sans Serif 字体。 |
| sansSerif
| Sans Serif 字体。
|
| casual
| 非正式字体。
|
| cursive
| 手写字体。
|
| smallCapitals
| 小型大写字母字体。
|
| sansSerif
| Sans Serif 字体。
|
| casual
| 非正式字体。
|
| cursive
| 手写字体。
|
| smallCapitals
| 小型大写字母字体。
|
## CaptionsStyle<sup>8+</sup>
...
...
@@ -134,14 +134,14 @@ import accessibility from '@ohos.accessibility';
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| fontFamily
|
[
CaptionsFontFamily
](
#captionsfontfamily8
)
| 是 | 否 | 描述字幕字体。
|
| fontScale
| number | 是 | 否
| 描述字幕字体缩放系数。 |
| fontColor
| number
\|
string | 是 | 否 | 描述字幕字体颜色。
|
| fontEdgeType
|
[
CaptionsFontEdgeType
](
#captionsfontedgetype8
)
| 是 | 否 | 描述字幕字体边缘。
|
| backgroundColor | number
\|
string
| 是 | 否 | 描述字幕背景颜色。
|
| windowColor
| number
\|
string | 是 | 否 | 描述字幕窗口颜色。
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
------- | ---------------------------------------- | ---- | ---- | ---
-------- |
| fontFamily
|
[
CaptionsFontFamily
](
#captionsfontfamily8
)
| 是 | 否 | 描述字幕字体。
|
| fontScale
| number | 是 | 否
| 描述字幕字体缩放系数。 |
| fontColor
| number
\|
string | 是 | 否 | 描述字幕字体颜色。
|
| fontEdgeType
|
[
CaptionsFontEdgeType
](
#captionsfontedgetype8
)
| 是 | 否 | 描述字幕字体边缘。
|
| backgroundColor | number
\|
string
| 是 | 否 | 描述字幕背景颜色。
|
| windowColor
| number
\|
string | 是 | 否 | 描述字幕窗口颜色。
|
## CaptionsManager<sup>8+</sup>
...
...
@@ -151,10 +151,10 @@ import accessibility from '@ohos.accessibility';
### 属性
| 名称
| 类型 | 可读 | 可写 | 说明
|
| -------
- | -------- | -------- | -------- |
-------- |
| enabled | boolean
| 是 | 否
| 表示是否启用字幕配置。 |
| style
|
[
CaptionsStyle
](
#captionsstyle8
)
| 是 | 否 | 表示字幕风格。
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| -------
| -------------------------------- | ---- | ---- | ---
-------- |
| enabled | boolean
| 是 | 否
| 表示是否启用字幕配置。 |
| style
|
[
CaptionsStyle
](
#captionsstyle8
)
| 是 | 否 | 表示字幕风格。
|
### on('enableChange')
...
...
@@ -164,10 +164,10 @@ on(type: 'enableChange', callback: Callback<boolean>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 监听的事件名,固定为‘enableChange’,即字幕配置启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | -------------------------------
-------- |
| type
| string | 是
| 监听的事件名,固定为‘enableChange’,即字幕配置启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -190,10 +190,10 @@ on(type: 'styleChange', callback: Callback<CaptionsStyle>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 监听的事件名,固定为‘styleChange’,即字幕风格变化事件。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 是
| 回调函数,在字幕风格变化时通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | --------------------------
-------- |
| type
| string | 是
| 监听的事件名,固定为‘styleChange’,即字幕风格变化事件。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 是
| 回调函数,在字幕风格变化时通过此函数进行通知。
|
**示例:**
...
...
@@ -218,10 +218,10 @@ off(type: 'enableChange', callback?: Callback<boolean>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 取消监听的事件名,固定为‘enableChange’,即字幕配置启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在字幕配置启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | --------------------------------
-------- |
| type
| string | 是
| 取消监听的事件名,固定为‘enableChange’,即字幕配置启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在字幕配置启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -244,10 +244,10 @@ off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 取消监听的事件名,固定为‘styleChange’,即字幕风格变化事件。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 否
| 回调函数,在字幕风格变化时通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | ----------------------------
-------- |
| type
| string | 是
| 取消监听的事件名,固定为‘styleChange’,即字幕风格变化事件。 |
| callback | Callback
<
[CaptionsStyle](#captionsstyle8)
>
| 否
| 回调函数,在字幕风格变化时通过此函数进行通知。
|
**示例:**
...
...
@@ -272,22 +272,22 @@ try {
### 属性
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
| -------- | -------- | -------- |
-------- |
| type
|
[
EventType
](
#eventtype
)
| 是 | 是 | 无障碍事件类型。
|
| windowUpdateType |
[
WindowUpdateType
](
#windowupdatetype
)
| 是
| 是 | 窗口变化类型。
|
| bundleName
| string | 是 | 是 | 目标应用名。
|
| componentType
| string | 是 | 是 | 事件源组件类型,如按钮、图表。
|
| pageId
| number | 是 | 是 | 事件源的页面 ID。
|
| description
| string | 是 | 是 | 事件描述。
|
| triggerAction
|
[
Action
](
#action
)
| 是 | 是 | 触发事件的 Action。
|
| textMoveUnit
|
[
TextMoveUnit
](
#textmoveunit
)
| 是 | 是 | 文本移动粒度。
|
| contents
| Array
<
string
>
| 是 | 是 | 内容列表。
|
| lastContent
| string | 是 | 是 | 最新内容。
|
| beginIndex
| number | 是 | 是 | 画面显示条目的开始序号
。 |
| currentIndex
| number | 是 | 是 | 当前条目序号。
|
| endIndex
| number | 是 | 是 | 画面显示条目的结束序号
。 |
| itemCount
| number | 是 | 是 | 条目总数。
|
| 名称
| 类型 | 可读 | 可写 | 说明
|
| --------
-------- | ------------------------------------- | ---- | ---- | -------------
-------- |
| type
|
[
EventType
](
#eventtype
)
| 是 | 是 | 无障碍事件类型。
|
| windowUpdateType |
[
WindowUpdateType
](
#windowupdatetype
)
| 是
| 是 | 窗口变化类型。
|
| bundleName
| string | 是 | 是 | 目标应用名。
|
| componentType
| string | 是 | 是 | 事件源组件类型,如按钮、图表。
|
| pageId
| number | 是 | 是 | 事件源的页面 ID。
|
| description
| string | 是 | 是 | 事件描述;当前版本暂不支持。
|
| triggerAction
|
[
Action
](
#action
)
| 是 | 是 | 触发事件的 Action。
|
| textMoveUnit
|
[
TextMoveUnit
](
#textmoveunit
)
| 是 | 是 | 文本移动粒度;当前版本暂不支持。
|
| contents
| Array
<
string
>
| 是 | 是 | 内容列表。
|
| lastContent
| string | 是 | 是 | 最新内容。
|
| beginIndex
| number | 是 | 是 | 画面显示条目的开始序号;当前版本暂不支持
。 |
| currentIndex
| number | 是 | 是 | 当前条目序号;当前版本暂不支持。
|
| endIndex
| number | 是 | 是 | 画面显示条目的结束序号;当前版本暂不支持
。 |
| itemCount
| number | 是 | 是 | 条目总数;当前版本暂不支持。
|
### constructor
...
...
@@ -299,9 +299,9 @@ constructor(jsonObject)
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| jsonObject | string | 是 | 创建对象所需要的 JSON 格式字符串。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
-- | ------ | ---- | ------------
-------- |
| jsonObject | string | 是
| 创建对象所需要的 JSON 格式字符串。 |
**示例:**
...
...
@@ -319,19 +319,19 @@ constructor(jsonObject)
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| --------
|
-------- |
| click
| 描述点击组件的事件。
|
| longClick
| 描述长按组件的事件。
|
| select
| 描述选择组件的事件。
|
| focus
| 描述组件获得焦点的事件。
|
| textUpdate
| 描述组件文本已更改的事件
。 |
| hoverEnter
| 描述悬停进入组件的事件。
|
| hoverExit
| 描述悬停离开组件的事件。
|
| scroll
| 描述滚动视图的事件。
|
| textSelectionUpdate
| 描述选定文本已更改的事件
。 |
| accessibilityFocus
| 描述获得无障碍焦点的事件。
|
| accessibilityFocusClear | 描述清除无障碍焦点的事件。 |
| 名称
| 描述
|
| --------
--------------- | --------------
-------- |
| click
| 描述点击组件的事件。
|
| longClick
| 描述长按组件的事件。
|
| select
| 描述选择组件的事件;当前版本暂不支持。
|
| focus
| 描述组件获得焦点的事件;当前版本暂不支持。
|
| textUpdate
| 描述组件文本已更改的事件;当前版本暂不支持
。 |
| hoverEnter
| 描述悬停进入组件的事件;当前版本暂不支持。
|
| hoverExit
| 描述悬停离开组件的事件;当前版本暂不支持。
|
| scroll
| 描述滚动视图的事件;当前版本暂不支持。
|
| textSelectionUpdate
| 描述选定文本已更改的事件;当前版本暂不支持
。 |
| accessibilityFocus
| 描述获得无障碍焦点的事件。
|
| accessibilityFocusClear | 描述清除无障碍焦点的事件。
|
## TextMoveUnit
...
...
@@ -339,12 +339,12 @@ constructor(jsonObject)
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| --------
|
-------- |
| char | 以字符为移动粒度遍历节点文本。 |
| word
| 以词为移动粒度遍历节点文本。
|
| line
| 以行为移动粒度遍历节点文本。
|
| page
| 以页为移动粒度遍历节点文本。
|
| 名称
| 描述
|
| --------
- | -------
-------- |
| char
| 以字符为移动粒度遍历节点文本。 |
| word
| 以词为移动粒度遍历节点文本。
|
| line
| 以行为移动粒度遍历节点文本。
|
| page
| 以页为移动粒度遍历节点文本。
|
| paragraph | 以段落为移动粒度遍历节点文本。 |
## WindowUpdateType
...
...
@@ -353,13 +353,13 @@ constructor(jsonObject)
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称
| 描述
|
| ------
-- |
-------- |
| add
| 添加窗口的窗口变化事件。
|
| remove | 一个窗口被删除的窗口变化事件。 |
| bounds | 窗口边界已更改的窗口变化事件。 |
| 名称
| 描述
|
| ------
| ----------
-------- |
| add
| 添加窗口的窗口变化事件。
|
| remove | 一个窗口被删除的窗口变化事件。
|
| bounds | 窗口边界已更改的窗口变化事件。
|
| active | 窗口变为活动或不活动的窗口变化事件。 |
| focus
| 窗口焦点发生变化的窗口变化事件。
|
| focus
| 窗口焦点发生变化的窗口变化事件。
|
## accessibility.getAbilityLists<sup>(deprecated)</sup>
...
...
@@ -376,15 +376,15 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<A
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | ----
---- | -------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是
| 辅助应用的类型。 |
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是
| 辅助应用的状态。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ----------------------------- |
---- | -------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是
| 辅助应用的类型。 |
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是
| 辅助应用的状态。 |
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------------------------- | -------------
-------- |
| Promise
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| Promise对象,返回辅助应用信息列表。 |
**示例:**
...
...
@@ -426,11 +426,11 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是 | 辅助应用的类型。
|
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。
|
| callback
| AsyncCallback
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 是
| 回调函数,返回辅助应用信息列表。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ---------------------------------------- | ---- | --------
-------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是 | 辅助应用的类型。
|
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。
|
| callback
| AsyncCallback
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 是
| 回调函数,返回辅助应用信息列表。 |
**示例:**
...
...
@@ -470,15 +470,15 @@ getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState)
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | ----
---- | -------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是
| 辅助应用的类型。 |
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是
| 辅助应用的状态。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ----------------------------- |
---- | -------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是
| 辅助应用的类型。 |
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是
| 辅助应用的状态。 |
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------------------------- | -------------
-------- |
| Promise
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| Promise对象,返回辅助应用信息列表。 |
**示例:**
...
...
@@ -515,11 +515,11 @@ getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState,
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
| -------- | -------- |
-------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是 | 辅助应用的类型。
|
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。
|
| callback
| AsyncCallback
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 是
| 回调函数,返回辅助应用信息列表。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ---------------------------------------- | ---- | --------
-------- |
| abilityType |
[
AbilityType
](
#abilitytype
)
| 是 | 辅助应用的类型。
|
| stateType
|
[
AbilityState
](
#abilitystate
)
| 是 | 辅助应用的状态。
|
| callback
| AsyncCallback
<
Array
<
[AccessibilityAbilityInfo](#accessibilityabilityinfo)
>>
| 是
| 回调函数,返回辅助应用信息列表。 |
**示例:**
...
...
@@ -557,8 +557,8 @@ getCaptionsManager(): CaptionsManager
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
---------------------------- | --
-------- |
|
[
CaptionsManager
](
#captionsmanager8
)
| 无障碍字幕配置管理。 |
**示例:**
...
...
@@ -577,10 +577,10 @@ on(type: 'accessibilityStateChange', callback: Callback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 监听的事件名,固定为‘accessibilityStateChange’,即辅助应用启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在辅助应用启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | --------------------------------
-------- |
| type
| string | 是
| 监听的事件名,固定为‘accessibilityStateChange’,即辅助应用启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在辅助应用启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -604,10 +604,10 @@ on(type: 'touchGuideStateChange', callback: Callback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 是
| 监听的事件名,固定为‘touchGuideStateChange’,即触摸浏览启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在触摸浏览启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | --------------------------------
-------- |
| type
| string | 是
| 监听的事件名,固定为‘touchGuideStateChange’,即触摸浏览启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 是
| 回调函数,在触摸浏览启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -631,10 +631,10 @@ off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 否
| 取消监听的事件名,固定为‘accessibilityStateChange’,即辅助应用启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在辅助应用启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | --------------------------------
-------- |
| type
| string | 否
| 取消监听的事件名,固定为‘accessibilityStateChange’,即辅助应用启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在辅助应用启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -658,10 +658,10 @@ off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| type
| string | 否
| 取消监听的事件名,固定为‘touchGuideStateChange’,即触摸浏览启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在触摸浏览启用状态变化时将状态通过此函数进行通知。
|
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
--------------- | ---- | --------------------------------
-------- |
| type
| string | 否
| 取消监听的事件名,固定为‘touchGuideStateChange’,即触摸浏览启用状态变化事件。 |
| callback | Callback
<
boolean
>
| 否
| 回调函数,在触摸浏览启用状态变化时将状态通过此函数进行通知。
|
**示例:**
...
...
@@ -685,8 +685,8 @@ isOpenAccessibility(): Promise<boolean>
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------- | --------------------------------
-------- |
| Promise
<
boolean
>
| Promise对象,如果辅助功能已启用,则返回 true;否则返回 false。 |
**示例:**
...
...
@@ -709,9 +709,9 @@ isOpenAccessibility(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,如果辅助功能已启用,则返回 true;否则返回 false。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------- | ---- | ---------------------------
-------- |
| callback | AsyncCallback
<
boolean
>
| 是
| 回调函数,如果辅助功能已启用,则返回 true;否则返回 false。 |
**示例:**
...
...
@@ -735,8 +735,8 @@ isOpenTouchGuide(): Promise<boolean>
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
-------------- | --------------------------------
-------- |
| Promise
<
boolean
>
| Promise对象,如果触摸浏览模式已开启,则返回 true;否则返回 false。 |
**示例:**
...
...
@@ -759,9 +759,9 @@ isOpenTouchGuide(callback: AsyncCallback<boolean>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback | AsyncCallback
<
boolean
>
| 是 | 回调函数,如果触摸浏览模式已开启,则返回 true;否则返回 false。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------- | ---- | -----------------------------
-------- |
| callback | AsyncCallback
<
boolean
>
| 是
| 回调函数,如果触摸浏览模式已开启,则返回 true;否则返回 false。 |
**示例:**
...
...
@@ -790,14 +790,14 @@ sendEvent(event: EventInfo): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
--- | -------- | ----
---- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是 | 无障碍事件对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ----------------------- |
---- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是
| 无障碍事件对象。 |
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------
-------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
...
...
@@ -830,10 +830,10 @@ sendEvent(event: EventInfo, callback: AsyncCallback<void>): void
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| event
|
[
EventInfo
](
#eventinfo
)
| 是 | 辅助事件对象。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,如果发送无障碍事件失败,则 AsyncCallback中err有数据返回。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------------------------
-------- |
| event
|
[
EventInfo
](
#eventinfo
)
| 是 | 辅助事件对象。
|
| callback | AsyncCallback
<
void
>
| 是
| 回调函数,如果发送无障碍事件失败,则 AsyncCallback中err有数据返回。 |
**示例:**
...
...
@@ -862,14 +862,14 @@ sendAccessibilityEvent(event: EventInfo): Promise<void>
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----
--- | -------- | ----
---- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是 | 无障碍事件对象。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----
| ----------------------- |
---- | -------- |
| event |
[
EventInfo
](
#eventinfo
)
| 是
| 无障碍事件对象。 |
**返回值:**
| 类型
| 说明
|
| --------
|
-------- |
| 类型
| 说明
|
| --------
----------- | --------
-------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
...
...
@@ -901,10 +901,10 @@ sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback<void>): v
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| event
|
[
EventInfo
](
#eventinfo
)
| 是 | 辅助事件对象。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,如果发送无障碍事件失败,则 AsyncCallback中err有数据返回。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
----------------- | ---- | --------------------------------
-------- |
| event
|
[
EventInfo
](
#eventinfo
)
| 是 | 辅助事件对象。
|
| callback | AsyncCallback
<
void
>
| 是
| 回调函数,如果发送无障碍事件失败,则 AsyncCallback中err有数据返回。 |
**示例:**
...
...
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @
d653d420
...
...
@@ -16,9 +16,9 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**系统能力:**
SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 类型
| 可读 | 可写 | 说明
|
| -------
-- | -------- | ---- | ---- | -------------
------------ |
| context |
[
AccessibilityExtensionContext
](
js-apis-inner-application-accessibilityExtensionContext.md
)
| 是
| 否
| 表示辅助扩展能力上下文。 |
| 名称 | 类型
| 可读 | 可写 | 说明
|
| -------
| ---------------------------------------- | ---- | ---- |
------------ |
| context |
[
AccessibilityExtensionContext
](
js-apis-inner-application-accessibilityExtensionContext.md
)
| 是
| 否
| 表示辅助扩展能力上下文。 |
## AccessibilityEvent
...
...
@@ -28,11 +28,11 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
### 属性
| 名称 | 类型
| 可读 | 可写 | 说明
|
| --------- | ---------------------------------------- | ---- | ---- | ---------- |
| eventType |
[
accessibility.EventType
](
js-apis-accessibility.md#EventType
)
\|
[
accessibility.WindowUpdateType
](
js-apis-accessibility.md#WindowUpdateType
)
\|
[
TouchGuideType
](
#touchguidetype
)
\|
[
GestureType
](
#gesturetype
)
\|
[
PageUpdateType
](
#pageupdatetype
)
| 是 | 否 | 具体事件类型
。
|
| target |
[
AccessibilityElement
](
js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9
)
| 是 | 否 | 发生事件的目标组件。
|
| timeStamp | number | 是 | 否 | 事件时间戳。 |
| 名称 | 类型
| 可读 | 可写 | 说明
|
| --------- | ---------------------------------------- | ---- | ---- | ----------
--------------------
|
| eventType |
[
accessibility.EventType
](
js-apis-accessibility.md#EventType
)
\|
[
accessibility.WindowUpdateType
](
js-apis-accessibility.md#WindowUpdateType
)
\|
[
TouchGuideType
](
#touchguidetype
)
\|
[
GestureType
](
#gesturetype
)
\|
[
PageUpdateType
](
#pageupdatetype
)
| 是 | 否 | 具体事件类型
;当前版本暂不支持PageUpdateType。
|
| target |
[
AccessibilityElement
](
js-apis-inner-application-accessibilityExtensionContext.md#accessibilityelement9
)
| 是 | 否 | 发生事件的目标组件。
|
| timeStamp | number | 是 | 否 | 事件时间戳。
|
## GestureType
...
...
@@ -40,8 +40,8 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| ------------- | ------------ |
| 名称 | 描述
|
| ------------- | ------------
-------
|
| left | 类型为字符串,表示向左的手势。 |
| leftThenRight | 类型为字符串,表示先向左再向右的手势。 |
| leftThenUp | 类型为字符串,表示先向左再向上的手势。 |
...
...
@@ -61,12 +61,12 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
## PageUpdateType
页面刷新类型。
页面刷新类型
;当前版本暂不支持
。
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| ----------------- | --------- |
| 名称 | 描述
|
| ----------------- | ---------
-------
|
| pageContentUpdate | 类型为字符串,表示页面内容刷新。 |
| pageStateUpdate | 类型为字符串,表示页面状态刷新。 |
...
...
@@ -76,8 +76,8 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| ---------- | ------------ |
| 名称 | 描述
|
| ---------- | ------------
-------
|
| touchBegin | 类型为字符串,表示触摸浏览时开始触摸。 |
| touchEnd | 类型为字符串,表示触摸浏览时结束触摸。 |
...
...
@@ -127,7 +127,7 @@ onAccessibilityEvent(event: AccessibilityEvent): void;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型
| 必填 | 说明 |
| ----- | ---------------------------------------- | ---- | --------------- |
| event |
[
AccessibilityEvent
](
#accessibilityevent
)
| 是 | 无障碍事件回调函数。无返回值。 |
...
...
@@ -154,7 +154,7 @@ onKeyEvent(keyEvent: KeyEvent): boolean;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型
| 必填 | 说明 |
| -------- | ---------------------------------------- | ---- | ----------------------- |
| keyEvent |
[
KeyEvent
](
js-apis-keyevent.md#KeyEvent
)
| 是 | 按键事件回调函数。返回true表示拦截此按键。 |
...
...
zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
浏览文件 @
d653d420
...
...
@@ -57,7 +57,7 @@ class EntryAbility extends AccessibilityExtensionAbility {
**系统能力**
:以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| 名称 | 类型
| 可读 | 可写 | 说明 |
| ------ | ------ | ---- | ---- | --------- |
| left | number | 是 | 否 | 矩形区域的左边界。 |
| top | number | 是 | 否 | 矩形区域的上边界。 |
...
...
@@ -85,14 +85,14 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<void>;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型
| 必填 | 说明 |
| ----------- | ------------------- | ---- | -------- |
| targetNames | Array
<
string
>
| 是 | 关注的目标包名。 |
**返回值:**
| 类型
| 说明
|
| -------------------
--- | -----
---------------- |
| 类型
| 说明
|
| -------------------
|
---------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**示例:**
...
...
@@ -120,9 +120,9 @@ setTargetBundleName(targetNames: Array\<string>, callback: AsyncCallback\<void>)
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | -------------------
| ---- |
-------- |
| targetNames | Array
<
string
>
| 是 | 关注的目标包名。
|
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | -------------------
------ | ---- | --------------------------------
-------- |
| targetNames | Array
<
string
>
| 是 | 关注的目标包名。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,如果设置关注的目标包名失败,则AsyncCallback中err有数据返回。 |
**示例:**
...
...
@@ -152,7 +152,7 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
**参数:**
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型
| 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| isAccessibilityFocus | boolean | 否 | 获取的是否是无障碍焦点元素,默认为否。 |
...
...
@@ -166,8 +166,8 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -196,16 +196,16 @@ getFocusElement(callback: AsyncCallback\<AccessibilityElement>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回当前对应的焦点元素。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | ---------
-------- |
| callback | AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回当前对应的焦点元素。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -236,10 +236,10 @@ getFocusElement(isAccessibilityFocus: boolean, callback: AsyncCallback\<Accessib
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| -------------------- | -------
| ---- | --
----------------- |
| isAccessibilityFocus | boolean
| 是 | 获取的是否是无障碍焦点元素。
|
| callback | AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回当前对应的焦点元素。 |
| 参数名 | 类型
| 必填 | 说明
|
| -------------------- | -------
--------------------------------- | ---- |
----------------- |
| isAccessibilityFocus | boolean
| 是 | 获取的是否是无障碍焦点元素。
|
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回当前对应的焦点元素。 |
**示例:**
...
...
@@ -269,8 +269,8 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------ | ------- | ---- |
------------------- |
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ------ | ---- | ---
------------------- |
| windowId | number | 否 | 指定窗口的编号,未指定则从当前活跃窗口获取。 |
**返回值:**
...
...
@@ -283,8 +283,8 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -313,16 +313,16 @@ getWindowRootElement(callback: AsyncCallback\<AccessibilityElement>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回指定窗口的根节点元素。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | ----------
-------- |
| callback | AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回指定窗口的根节点元素。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -353,17 +353,17 @@ getWindowRootElement(windowId: number, callback: AsyncCallback\<AccessibilityEle
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
------------ | ------- | ---- |
------------------- |
| windowId | number | 是 | 指定窗口的编号,未指定则从当前活跃窗口获取。 |
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回指定窗口的根节点元素。
|
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | ---
------------------- |
| windowId | number
| 是 | 指定窗口的编号,未指定则从当前活跃窗口获取。 |
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回指定窗口的根节点元素。
|
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -395,22 +395,22 @@ getWindows(displayId?: number): Promise\<Array\<AccessibilityElement>>;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
----------- | ------- | ---- |
------------------- |
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ------ | ---- | --
------------------- |
| displayId | number | 否 | 指定的屏幕编号,未指定则从默认主屏幕获取。 |
**返回值:**
| 类型 | 说明 |
| ----------------------------------- | ---------------------- |
| 类型
| 说明 |
| -----------------------------------
-----
| ---------------------- |
| Promise
<
Array
<
AccessibilityElement
>>
| Promise对象,返回指定屏幕的所有窗口。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -439,16 +439,16 @@ getWindows(callback: AsyncCallback\<Array\<AccessibilityElement>>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
| -------- |
-------- |
| callback
| AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回指定屏幕的所有窗口。 |
| 参数名
| 类型 | 必填 | 说明
|
| -------- | --------
-------------------------------- | ---- | ---------
-------- |
| callback | AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回指定屏幕的所有窗口。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -479,17 +479,17 @@ getWindows(displayId: number, callback: AsyncCallback\<Array\<AccessibilityEleme
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
----------- | ------- | ---- |
------------------- |
| displayId | number | 是 | 指定的屏幕编号,未指定则从默认主屏幕获取。 |
| callback
| AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回指定屏幕的所有窗口。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ---------------------------------------- | ---- | --
------------------- |
| displayId | number
| 是 | 指定的屏幕编号,未指定则从默认主屏幕获取。 |
| callback
| AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回指定屏幕的所有窗口。
|
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -521,22 +521,22 @@ injectGesture(gesturePath: GesturePath): Promise\<void>;
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | ---------------------------------------- | ---- | ----------
----
|
| gesturePath |
[
GesturePath
](
js-apis-accessibility-GesturePath.md#gesturepath
)
| 是 | 表示手势的路径信息。
|
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | ---------------------------------------- | ---- | ---------- |
| gesturePath |
[
GesturePath
](
js-apis-accessibility-GesturePath.md#gesturepath
)
| 是 | 表示手势的路径信息。 |
**返回值:**
| 类型
| 说明
|
| -------------------
---------------- | ------
---------------- |
| 类型
| 说明
|
| -------------------
|
---------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -569,17 +569,17 @@ injectGesture(gesturePath: GesturePath, callback: AsyncCallback\<void>): void
**参数:**
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | ---------------------------------------- | ---- | -------------- |
| gesturePath |
[
GesturePath
](
js-apis-accessibility-GesturePath.md#gesturepath
)
| 是 | 表示手势的路径信息。 |
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,表示注入手势执行结果的回调。 |
| 参数名 | 类型
| 必填 | 说明
|
| ----------- | ---------------------------------------- | ---- | --------------
-----
|
| gesturePath |
[
GesturePath
](
js-apis-accessibility-GesturePath.md#gesturepath
)
| 是 | 表示手势的路径信息。
|
| callback | AsyncCallback
<
void
>
| 是 | 回调函数,表示注入手势执行结果的回调。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -------------------------------- |
| 错误码ID
| 错误信息
|
| ------- | --------------------------------
--------
|
| 9300003 | Do not have accessibility right for this operation. |
**示例:**
...
...
@@ -620,8 +620,8 @@ attributeNames\<T extends keyof ElementAttributeValues>(): Promise\<Array\<T>>;
**返回值:**
| 类型
| 说明 |
| -----------------------------
-----------
| ------------------------ |
| 类型 | 说明 |
| ----------------------------- | ------------------------ |
| Promise
<
Array
<
T
>>
| Promise对象,返回节点元素的所有属性名称。 |
**示例:**
...
...
@@ -646,9 +646,9 @@ attributeNames\<T extends keyof ElementAttributeValues>(callback: AsyncCallback\
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ---------------------------------------- | ---- |
-------------- |
| callback
| AsyncCallback
<
Array
<
T
>>
| 是 | 回调函数,返回节点元素的所有属性名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ----------------------------------- | ---- | -----
-------------- |
| callback
| AsyncCallback
<
Array
<
T
>>
| 是 | 回调函数,返回节点元素的所有属性名称。 |
**示例:**
...
...
@@ -674,22 +674,22 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T): Promi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----------
| ---------------------------------------- | ---- | ------
-------- |
| attributeName | T
| 是 | 表示属性的名称。
|
| 参数名
| 类型 | 必填 | 说明
|
| -----------
-- | ---- | ---- |
-------- |
| attributeName | T
| 是 | 表示属性的名称。
|
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| 类型 | 说明
|
| ---------------------------------------- | ------------------------
---
|
| Promise
<
ElementAttributeValues[T]
>
| Promise对象,返回根据节点属性名称获取的属性值。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -----------------------------
---
|
| 错误码ID
| 错误信息
|
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**示例:**
...
...
@@ -720,17 +720,17 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T,
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| -----------
| ---------------------------------------- | ---- |
-------------- |
| attributeName | T
| 是 | 表示属性的名称。
|
| callback
| AsyncCallback
<
ElementAttributeValues[T]
>
| 是 | 回调函数,返回根据节点属性名称获取的属性值。 |
| 参数名
| 类型 | 必填 | 说明
|
| -----------
-- | ---------------------------------------- | ---- | --------
-------------- |
| attributeName | T
| 是 | 表示属性的名称。
|
| callback
| AsyncCallback
<
ElementAttributeValues[T]
>
| 是 | 回调函数,返回根据节点属性名称获取的属性值。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -----------------------------
---
|
| 错误码ID
| 错误信息
|
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**示例:**
...
...
@@ -762,8 +762,8 @@ actionNames(): Promise\<Array\<string>>;
**返回值:**
| 类型
| 说明
|
| ----------------------------------
------ |
------------------------ |
| 类型
| 说明
|
| ----------------------------------
| --
------------------------ |
| Promise
<
Array
<
string
>>
| Promise对象,返回节点元素支持的所有操作名称。 |
**示例:**
...
...
@@ -788,9 +788,9 @@ actionNames(callback: AsyncCallback\<Array\<string>>): void;
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| --------
--- | ---------------------------------------- | ---- |
-------------- |
| callback
| AsyncCallback
<
Array
<
string
>>
| 是 | 回调函数,返回节点元素支持的所有操作名称。 |
| 参数名
| 类型 | 必填 | 说明
|
| --------
| ---------------------------------------- | ---- | -------
-------------- |
| callback
| AsyncCallback
<
Array
<
string
>>
| 是 | 回调函数,返回节点元素支持的所有操作名称。 |
**示例:**
...
...
@@ -819,20 +819,20 @@ performAction(actionName: string, parameters?: object): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| actionName | string | 是 | 表示属性的名称,取值参考
[
Action
](
./js-apis-accessibility.md#action
)
。
| parameters | object | 否 | 表示执行操作时所需要的参数。 |
| parameters | object | 否 | 表示执行操作时所需要的参数
;当前版本暂不支持
。 |
**返回值:**
| 类型
| 说明
|
| -------------------
--------------------- | --------
---------------- |
| 类型
| 说明
|
| -------------------
|
---------------- |
| Promise
<
void
>
| 无返回结果的Promise对象。 |
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -----------------------------
---
|
| 错误码ID
| 错误信息
|
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例:**
...
...
@@ -868,8 +868,8 @@ performAction(actionName: string, callback: AsyncCallback\<void>): void;
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -----------------------------
---
|
| 错误码ID
| 错误信息
|
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例:**
...
...
@@ -898,18 +898,18 @@ performAction(actionName: string, parameters: object, callback: AsyncCallback\<v
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ----------
- | ---------------------------------------- | ---- |
-------------- |
| actionName | string | 是 | 表示属性的名称,取值参考
[
Action
](
./js-apis-accessibility.md#action
)
。 |
| parameters | object
| 是 | 表示执行操作时所需要的参数。
|
| callback
| AsyncCallback
<
void
>
| 是 | 回调函数,表示执行指定操作的回调。
|
| 参数名
| 类型 | 必填 | 说明
|
| ----------
| ------------------------- | ---- | --------------------------
-------------- |
| actionName | string
| 是 | 表示属性的名称,取值参考
[
Action
](
./js-apis-accessibility.md#action
)
。 |
| parameters | object
| 是 | 表示执行操作时所需要的参数;当前版本暂不支持。
|
| callback
| AsyncCallback
<
void
>
| 是 | 回调函数,表示执行指定操作的回调。
|
**错误码:**
以下错误码的详细介绍请参见
[
无障碍子系统错误码
](
../errorcodes/errorcode-accessibility.md
)
。
| 错误码ID
| 错误信息
|
| ------- | -----------------------------
---
|
| 错误码ID
| 错误信息
|
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例:**
...
...
@@ -942,15 +942,15 @@ findElement(type: 'content', condition: string): Promise\<Array\<AccessibilityEl
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'content', 表示查找的类型为节点元素内容。
|
| condition | string | 是 | 表示查找的条件。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ------ | ---- | ---------------
-------------- |
| type
| string | 是 | 固定为'content', 表示查找的类型为节点元素内容。
|
| condition | string | 是 | 表示查找的条件。
|
**返回值:**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| 类型 | 说明
|
| ---------------------------------------- | ------------------------
-----
|
| Promise
<
Array
<
AccessibilityElement
>>
| Promise对象,返回满足指定查询关键字的所有节点元素。 |
**示例:**
...
...
@@ -981,11 +981,11 @@ findElement(type: 'content', condition: string, callback: AsyncCallback\<Array\<
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'content',表示查找的类型为节点元素内容。
|
| condition | string
| 是 | 表示查找的条件。
|
| callback
| AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回满足指定查询关键字的所有节点元素。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ---------------------------------------- | ---- | --------------
-------------- |
| type
| string | 是 | 固定为'content',表示查找的类型为节点元素内容。
|
| condition | string
| 是 | 表示查找的条件。
|
| callback
| AsyncCallback
<
Array
<
AccessibilityElement
>>
| 是 | 回调函数,返回满足指定查询关键字的所有节点元素。
|
**示例:**
...
...
@@ -1017,15 +1017,15 @@ findElement(type: 'focusType', condition: FocusType): Promise\<AccessibilityElem
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。
|
| condition |
[
FocusType
](
#focustype
)
| 是 | 表示查询焦点元素的类型。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ----------------------- | ---- | --------------------
-------------- |
| type
| string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。
|
| condition |
[
FocusType
](
#focustype
)
| 是 | 表示查询焦点元素的类型。
|
**返回值:**
| 类型
| 说明
|
| -----------------------------------
----- |
------------------------ |
| 类型
| 说明
|
| -----------------------------------
| ------
------------------------ |
| Promise
<
AccessibilityElement
>
| Promise对象,返回满足指定查询焦点元素类型的节点元素。 |
**示例:**
...
...
@@ -1056,11 +1056,11 @@ findElement(type: 'focusType', condition: FocusType, callback: AsyncCallback\<Ac
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。
|
| condition |
[
FocusType
](
#focustype
)
| 是 | 表示查询焦点元素的类型。
|
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回满足指定查询焦点元素类型的节点元素。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ---------------------------------------- | ---- | --------------------
-------------- |
| type
| string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。
|
| condition |
[
FocusType
](
#focustype
)
| 是 | 表示查询焦点元素的类型。
|
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回满足指定查询焦点元素类型的节点元素。
|
**示例:**
...
...
@@ -1092,15 +1092,15 @@ findElement(type: 'focusDirection', condition: FocusDirection): Promise\<Accessi
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。
|
| condition |
[
FocusDirection
](
#focusdirection
)
| 是 | 表示查询下一焦点元素的方向。 |
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| --------------------------------- | ---- | --------------------------
-------------- |
| type
| string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。
|
| condition |
[
FocusDirection
](
#focusdirection
)
| 是 | 表示查询下一焦点元素的方向。
|
**返回值:**
| 类型
| 说明
|
| -----------------------------------
----- |
------------------------ |
| 类型
| 说明
|
| -----------------------------------
| --------
------------------------ |
| Promise
<
AccessibilityElement
>
| Promise对象,返回满足指定查询下一焦点元素方向的节点元素。 |
**示例:**
...
...
@@ -1131,11 +1131,11 @@ findElement(type: 'focusDirection', condition: FocusDirection, callback: AsyncCa
**参数:**
| 参数名
| 类型 | 必填 | 说明
|
| ---------
-- | ---------------------------------------- | ---- |
-------------- |
| type
| string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。
|
| condition |
[
FocusDirection
](
#focusdirection
)
| 是 | 表示下一查询焦点元素的方向。
|
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回满足指定查询下一焦点元素方向的节点元素。
|
| 参数名
| 类型 | 必填 | 说明
|
| ---------
| ---------------------------------------- | ---- | --------------------------
-------------- |
| type
| string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。
|
| condition |
[
FocusDirection
](
#focusdirection
)
| 是 | 表示下一查询焦点元素的方向。
|
| callback
| AsyncCallback
<
AccessibilityElement
>
| 是 | 回调函数,返回满足指定查询下一焦点元素方向的节点元素。
|
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录