Skip to content

D
Docs

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

通知 161
Star 293
Fork 28
D
Docs
提交 1a3cf46e 编写于 作者: R r00447448
浏览文件
操作

无障碍软件服务开发指南修改 

Signed-off-by: Nranzhiqiang <ranzhiqiang@huawei.com>
上级 d64f57b1
显示空白变更内容
内联 并排
Showing with 351 addition and 351 deletion
zh-cn/application-dev/reference/apis/js-apis-accessibility.md
浏览文件 @ 1a3cf46e
......@@ -19,7 +19,7 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ------- | -------- |
| enable | 辅助应用已启用。 |
| disable | 辅助应用已禁用。 |
| install | 辅助应用已安装。 |
......@@ -31,7 +31,7 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ---------------- | --------- |
| audible | 表示具有听觉反馈。 |
| generic | 表示具有通用反馈。 |
| haptic | 表示具有触觉反馈。 |
......@@ -48,7 +48,7 @@ import accessibility from '@ohos.accessibility';
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------------------------------ | ---------------------------------------- | ---- | ---- | ---------------- |
| id | string | 是 | 否 | ability&nbsp;id。 |
| name | string | 是 | 否 | ability 名。 |
| bundleName | string | 是 | 否 | Bundle名称。 |
......@@ -65,23 +65,23 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ----------------------- | ------------------ |
| click | 表示点击操作。 |
| longClick | 表示长按操作。 |
| scrollForward | 表示向前滚动操作。 |
| scrollBackward | 表示向后滚动操作。 |
| focus | 表示获得焦点操作。 |
| clearFocus | 表示清除焦点操作。 |
| clearSelection | 表示清除选择操作。 |
| scrollForward | 表示向前滚动操作；当前版本暂不支持。 |
| scrollBackward | 表示向后滚动操作；当前版本暂不支持。 |
| focus | 表示获得焦点操作；当前版本暂不支持。 |
| clearFocus | 表示清除焦点操作；当前版本暂不支持。 |
| clearSelection | 表示清除选择操作；当前版本暂不支持。 |
| accessibilityFocus | 表示获得无障碍焦点操作。 |
| clearAccessibilityFocus | 表示清除无障碍焦点操作。 |
| cut | 表示剪切操作。 |
| copy | 表示复制操作。 |
| paste | 表示粘贴操作。 |
| select | 表示选择操作。 |
| setText | 表示设置文本操作。 |
| delete | 表示删除操作。 |
| setSelection | 表示选择操作。 |
| cut | 表示剪切操作；当前版本暂不支持。 |
| copy | 表示复制操作；当前版本暂不支持。 |
| paste | 表示粘贴操作；当前版本暂不支持。 |
| select | 表示选择操作，当前版本暂不支持。 |
| setText | 表示设置文本操作；当前版本暂不支持。 |
| delete | 表示删除操作；当前版本暂不支持。 |
| setSelection | 表示选择操作；当前版本暂不支持。 |
## Capability
......@@ -90,11 +90,11 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ---------------- | --------------------- |
| retrieve | 具有检索窗口内容的能力。 |
| touchGuide | 具有触摸探索模式的能力。 |
| keyEventObserver | 具有过滤按键事件的能力。 |
| zoom | 具有控制显示放大的能力。 |
| zoom | 具有控制显示放大的能力；当前版本暂不支持。 |
| gesture | 具有执行手势动作的能力。 |
## CaptionsFontEdgeType<sup>8+</sup>
......@@ -104,7 +104,7 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称 | 描述 |
| -------- | -------- |
| ---------- | ----- |
| none | 无效果。 |
| raised | 凸起效果。 |
| depressed | 凹陷效果。 |
......@@ -118,7 +118,7 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称 | 描述 |
| -------- | -------- |
| ------------------- | ----------------- |
| default | 默认字体。 |
| monospacedSerif | 等宽 Serif 字体。 |
| serif | Serif 字体。 |
......@@ -135,7 +135,7 @@ import accessibility from '@ohos.accessibility';
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| --------------- | ---------------------------------------- | ---- | ---- | ----------- |
| fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | 是 | 否 | 描述字幕字体。 |
| fontScale | number | 是 | 否 | 描述字幕字体缩放系数。 |
| fontColor | number \| string | 是 | 否 | 描述字幕字体颜色。 |
......@@ -152,7 +152,7 @@ import accessibility from '@ohos.accessibility';
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ------- | -------------------------------- | ---- | ---- | ----------- |
| enabled | boolean | 是 | 否 | 表示是否启用字幕配置。 |
| style | [CaptionsStyle](#captionsstyle8) | 是 | 否 | 表示字幕风格。 |
......@@ -165,7 +165,7 @@ on(type: 'enableChange', callback: Callback&lt;boolean&gt;): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | --------------------------------------- |
| type | string | 是 | 监听的事件名，固定为‘enableChange’，即字幕配置启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 是 | 回调函数，在启用状态变化时将状态通过此函数进行通知。 |
......@@ -191,7 +191,7 @@ on(type: 'styleChange', callback: Callback&lt;CaptionsStyle&gt;): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ---------------------------------- |
| type | string | 是 | 监听的事件名，固定为‘styleChange’，即字幕风格变化事件。 |
| callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | 是 | 回调函数，在字幕风格变化时通过此函数进行通知。 |
......@@ -219,7 +219,7 @@ off(type: 'enableChange', callback?: Callback&lt;boolean&gt;): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 取消监听的事件名，固定为‘enableChange’，即字幕配置启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 否 | 回调函数，在字幕配置启用状态变化时将状态通过此函数进行通知。 |
......@@ -245,7 +245,7 @@ off(type: 'styleChange', callback?: Callback&lt;CaptionsStyle&gt;): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ------------------------------------ |
| type | string | 是 | 取消监听的事件名，固定为‘styleChange’，即字幕风格变化事件。 |
| callback | Callback&lt;[CaptionsStyle](#captionsstyle8)&gt; | 否 | 回调函数，在字幕风格变化时通过此函数进行通知。 |
......@@ -273,21 +273,21 @@ try {
### 属性
| 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| ---------------- | ------------------------------------- | ---- | ---- | --------------------- |
| type | [EventType](#eventtype) | 是 | 是 | 无障碍事件类型。 |
| windowUpdateType | [WindowUpdateType](#windowupdatetype) | 是 | 是 | 窗口变化类型。 |
| bundleName | string | 是 | 是 | 目标应用名。 |
| componentType | string | 是 | 是 | 事件源组件类型，如按钮、图表。 |
| pageId | number | 是 | 是 | 事件源的页面 ID。 |
| description | string | 是 | 是 | 事件描述。 |
| description | string | 是 | 是 | 事件描述；当前版本暂不支持。 |
| triggerAction | [Action](#action) | 是 | 是 | 触发事件的 Action。 |
| textMoveUnit | [TextMoveUnit](#textmoveunit) | 是 | 是 | 文本移动粒度。 |
| textMoveUnit | [TextMoveUnit](#textmoveunit) | 是 | 是 | 文本移动粒度；当前版本暂不支持。 |
| contents | Array&lt;string&gt; | 是 | 是 | 内容列表。 |
| lastContent | string | 是 | 是 | 最新内容。 |
| beginIndex | number | 是 | 是 | 画面显示条目的开始序号。 |
| currentIndex | number | 是 | 是 | 当前条目序号。 |
| endIndex | number | 是 | 是 | 画面显示条目的结束序号。 |
| itemCount | number | 是 | 是 | 条目总数。 |
| beginIndex | number | 是 | 是 | 画面显示条目的开始序号；当前版本暂不支持。 |
| currentIndex | number | 是 | 是 | 当前条目序号；当前版本暂不支持。 |
| endIndex | number | 是 | 是 | 画面显示条目的结束序号；当前版本暂不支持。 |
| itemCount | number | 是 | 是 | 条目总数；当前版本暂不支持。 |
### constructor
......@@ -300,7 +300,7 @@ constructor(jsonObject)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ---------- | ------ | ---- | -------------------- |
| jsonObject | string | 是 | 创建对象所需要的 JSON 格式字符串。 |
**示例：**
......@@ -320,16 +320,16 @@ constructor(jsonObject)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ----------------------- | ---------------------- |
| click | 描述点击组件的事件。 |
| longClick | 描述长按组件的事件。 |
| select | 描述选择组件的事件。 |
| focus | 描述组件获得焦点的事件。 |
| textUpdate | 描述组件文本已更改的事件。 |
| hoverEnter | 描述悬停进入组件的事件。 |
| hoverExit | 描述悬停离开组件的事件。 |
| scroll | 描述滚动视图的事件。 |
| textSelectionUpdate | 描述选定文本已更改的事件。 |
| select | 描述选择组件的事件；当前版本暂不支持。 |
| focus | 描述组件获得焦点的事件；当前版本暂不支持。 |
| textUpdate | 描述组件文本已更改的事件；当前版本暂不支持。 |
| hoverEnter | 描述悬停进入组件的事件；当前版本暂不支持。 |
| hoverExit | 描述悬停离开组件的事件；当前版本暂不支持。 |
| scroll | 描述滚动视图的事件；当前版本暂不支持。 |
| textSelectionUpdate | 描述选定文本已更改的事件；当前版本暂不支持。 |
| accessibilityFocus | 描述获得无障碍焦点的事件。 |
| accessibilityFocusClear | 描述清除无障碍焦点的事件。 |
......@@ -340,7 +340,7 @@ constructor(jsonObject)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| --------- | --------------- |
| char | 以字符为移动粒度遍历节点文本。 |
| word | 以词为移动粒度遍历节点文本。 |
| line | 以行为移动粒度遍历节点文本。 |
......@@ -354,7 +354,7 @@ constructor(jsonObject)
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| -------- | -------- |
| ------ | ------------------ |
| add | 添加窗口的窗口变化事件。 |
| remove | 一个窗口被删除的窗口变化事件。 |
| bounds | 窗口边界已更改的窗口变化事件。 |
......@@ -377,14 +377,14 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise&lt;A
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ----------------------------- | ---- | -------- |
| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 |
| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise对象，返回辅助应用信息列表。 |
**示例：**
......@@ -427,7 +427,7 @@ getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: Asyn
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ---------------------------------------- | ---- | ---------------- |
| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 |
| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 |
| callback | AsyncCallback&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | 是 | 回调函数，返回辅助应用信息列表。 |
......@@ -471,14 +471,14 @@ getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ----------------------------- | ---- | -------- |
| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 |
| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------------------------- | --------------------- |
| Promise&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | Promise对象，返回辅助应用信息列表。 |
**示例：**
......@@ -516,7 +516,7 @@ getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----------- | ---------------------------------------- | ---- | ---------------- |
| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 |
| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 |
| callback | AsyncCallback&lt;Array&lt;[AccessibilityAbilityInfo](#accessibilityabilityinfo)&gt;&gt; | 是 | 回调函数，返回辅助应用信息列表。 |
......@@ -558,7 +558,7 @@ getCaptionsManager(): CaptionsManager
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------------------------ | ---------- |
| [CaptionsManager](#captionsmanager8) | 无障碍字幕配置管理。 |
**示例：**
......@@ -578,7 +578,7 @@ on(type: 'accessibilityStateChange', callback: Callback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 监听的事件名，固定为‘accessibilityStateChange’，即辅助应用启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 是 | 回调函数，在辅助应用启用状态变化时将状态通过此函数进行通知。 |
......@@ -605,7 +605,7 @@ on(type: 'touchGuideStateChange', callback: Callback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 监听的事件名，固定为‘touchGuideStateChange’，即触摸浏览启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 是 | 回调函数，在触摸浏览启用状态变化时将状态通过此函数进行通知。 |
......@@ -632,7 +632,7 @@ off(type: 'accessibilityStateChange', callback?: Callback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 否 | 取消监听的事件名，固定为‘accessibilityStateChange’，即辅助应用启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 否 | 回调函数，在辅助应用启用状态变化时将状态通过此函数进行通知。 |
......@@ -659,7 +659,7 @@ off(type: 'touchGuideStateChange', callback?: Callback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ----------------------- | ---- | ---------------------------------------- |
| type | string | 否 | 取消监听的事件名，固定为‘touchGuideStateChange’，即触摸浏览启用状态变化事件。 |
| callback | Callback&lt;boolean&gt; | 否 | 回调函数，在触摸浏览启用状态变化时将状态通过此函数进行通知。 |
......@@ -686,7 +686,7 @@ isOpenAccessibility(): Promise&lt;boolean&gt;
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象，如果辅助功能已启用，则返回 true；否则返回 false。 |
**示例：**
......@@ -710,7 +710,7 @@ isOpenAccessibility(callback: AsyncCallback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------- | ---- | ----------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，如果辅助功能已启用，则返回 true；否则返回 false。 |
**示例：**
......@@ -736,7 +736,7 @@ isOpenTouchGuide(): Promise&lt;boolean&gt;
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ---------------------- | ---------------------------------------- |
| Promise&lt;boolean&gt; | Promise对象，如果触摸浏览模式已开启，则返回 true；否则返回 false。 |
**示例：**
......@@ -760,7 +760,7 @@ isOpenTouchGuide(callback: AsyncCallback&lt;boolean&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------- | ---- | ------------------------------------- |
| callback | AsyncCallback&lt;boolean&gt; | 是 | 回调函数，如果触摸浏览模式已开启，则返回 true；否则返回 false。 |
**示例：**
......@@ -791,13 +791,13 @@ sendEvent(event: EventInfo): Promise&lt;void&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----- | ----------------------- | ---- | -------- |
| event | [EventInfo](#eventinfo) | 是 | 无障碍事件对象。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
......@@ -831,7 +831,7 @@ sendEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| event | [EventInfo](#eventinfo) | 是 | 辅助事件对象。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，如果发送无障碍事件失败，则 AsyncCallback中err有数据返回。 |
......@@ -863,13 +863,13 @@ sendAccessibilityEvent(event: EventInfo): Promise&lt;void&gt;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| ----- | ----------------------- | ---- | -------- |
| event | [EventInfo](#eventinfo) | 是 | 无障碍事件对象。 |
**返回值：**
| 类型 | 说明 |
| -------- | -------- |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
......@@ -902,7 +902,7 @@ sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback&lt;void&gt;): v
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ------------------------- | ---- | ---------------------------------------- |
| event | [EventInfo](#eventinfo) | 是 | 辅助事件对象。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，如果发送无障碍事件失败，则 AsyncCallback中err有数据返回。 |
......
zh-cn/application-dev/reference/apis/js-apis-application-accessibilityExtensionAbility.md
浏览文件 @ 1a3cf46e
......@@ -17,7 +17,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**系统能力：** SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 类型 | 可读 | 可写 | 说明 |
| --------- | -------- | ---- | ---- | ------------------------- |
| ------- | ---------------------------------------- | ---- | ---- | ------------ |
| context | [AccessibilityExtensionContext](js-apis-inner-application-accessibilityExtensionContext.md) | 是 | 否 | 表示辅助扩展能力上下文。 |
## AccessibilityEvent
......@@ -29,8 +29,8 @@ 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) | 是 | 否 | 具体事件类型。 |
| --------- | ---------------------------------------- | ---- | ---- | ------------------------------ |
| 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 | 是 | 否 | 事件时间戳。 |
......@@ -41,7 +41,7 @@ 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 | 类型为字符串，表示页面状态刷新。 |
......@@ -77,7 +77,7 @@ import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtens
**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core
| 名称 | 描述 |
| ---------- | ------------ |
| ---------- | ------------------- |
| touchBegin | 类型为字符串，表示触摸浏览时开始触摸。 |
| touchEnd | 类型为字符串，表示触摸浏览时结束触摸。 |
......
zh-cn/application-dev/reference/apis/js-apis-inner-application-accessibilityExtensionContext.md
浏览文件 @ 1a3cf46e
......@@ -92,7 +92,7 @@ setTargetBundleName(targetNames: Array\<string>): Promise\<void>;
**返回值：**
| 类型 | 说明 |
| ---------------------- | --------------------- |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**示例：**
......@@ -121,7 +121,7 @@ setTargetBundleName(targetNames: Array\<string>, callback: AsyncCallback\<void>)
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ------------------- | ---- | -------- |
| ----------- | ------------------------- | ---- | ---------------------------------------- |
| targetNames | Array&lt;string&gt; | 是 | 关注的目标包名。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，如果设置关注的目标包名失败，则AsyncCallback中err有数据返回。 |
......@@ -167,7 +167,7 @@ getFocusElement(isAccessibilityFocus?: boolean): Promise\<AccessibilityElement>;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -197,7 +197,7 @@ getFocusElement(callback: AsyncCallback\<AccessibilityElement>): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ----------------- |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回当前对应的焦点元素。 |
**错误码：**
......@@ -205,7 +205,7 @@ getFocusElement(callback: AsyncCallback\<AccessibilityElement>): void;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -237,7 +237,7 @@ getFocusElement(isAccessibilityFocus: boolean, callback: AsyncCallback\<Accessib
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| -------------------- | ---------------------------------------- | ---- | ----------------- |
| isAccessibilityFocus | boolean | 是 | 获取的是否是无障碍焦点元素。 |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回当前对应的焦点元素。 |
......@@ -270,7 +270,7 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| -------- | ------ | ---- | ---------------------- |
| windowId | number | 否 | 指定窗口的编号，未指定则从当前活跃窗口获取。 |
**返回值：**
......@@ -284,7 +284,7 @@ getWindowRootElement(windowId?: number): Promise\<AccessibilityElement>;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -314,7 +314,7 @@ getWindowRootElement(callback: AsyncCallback\<AccessibilityElement>): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ------------------ |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回指定窗口的根节点元素。 |
**错误码：**
......@@ -322,7 +322,7 @@ getWindowRootElement(callback: AsyncCallback\<AccessibilityElement>): void;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -354,7 +354,7 @@ getWindowRootElement(windowId: number, callback: AsyncCallback\<AccessibilityEle
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| -------- | ---------------------------------------- | ---- | ---------------------- |
| windowId | number | 是 | 指定窗口的编号，未指定则从当前活跃窗口获取。 |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回指定窗口的根节点元素。 |
......@@ -363,7 +363,7 @@ getWindowRootElement(windowId: number, callback: AsyncCallback\<AccessibilityEle
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -396,13 +396,13 @@ getWindows(displayId?: number): Promise\<Array\<AccessibilityElement>>;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| --------- | ------ | ---- | --------------------- |
| displayId | number | 否 | 指定的屏幕编号，未指定则从默认主屏幕获取。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------- | ---------------------- |
| ---------------------------------------- | ---------------------- |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise对象，返回指定屏幕的所有窗口。 |
**错误码：**
......@@ -410,7 +410,7 @@ getWindows(displayId?: number): Promise\<Array\<AccessibilityElement>>;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -440,7 +440,7 @@ getWindows(callback: AsyncCallback\<Array\<AccessibilityElement>>): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | ---------------------------------------- | ---- | ----------------- |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | 是 | 回调函数，返回指定屏幕的所有窗口。 |
**错误码：**
......@@ -448,7 +448,7 @@ getWindows(callback: AsyncCallback\<Array\<AccessibilityElement>>): void;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -480,7 +480,7 @@ getWindows(displayId: number, callback: AsyncCallback\<Array\<AccessibilityEleme
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| -------------------- | ------- | ---- | ------------------- |
| --------- | ---------------------------------------- | ---- | --------------------- |
| displayId | number | 是 | 指定的屏幕编号，未指定则从默认主屏幕获取。 |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | 是 | 回调函数，返回指定屏幕的所有窗口。 |
......@@ -489,7 +489,7 @@ getWindows(displayId: number, callback: AsyncCallback\<Array\<AccessibilityEleme
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -522,13 +522,13 @@ injectGesture(gesturePath: GesturePath): Promise\<void>;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| ----------- | ---------------------------------------- | ---- | ---------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | 是 | 表示手势的路径信息。 |
**返回值：**
| 类型 | 说明 |
| ----------------------------------- | ---------------------- |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
......@@ -536,7 +536,7 @@ injectGesture(gesturePath: GesturePath): Promise\<void>;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -570,7 +570,7 @@ injectGesture(gesturePath: GesturePath, callback: AsyncCallback\<void>): void
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| ----------- | ---------------------------------------- | ---- | ------------------- |
| gesturePath | [GesturePath](js-apis-accessibility-GesturePath.md#gesturepath) | 是 | 表示手势的路径信息。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，表示注入手势执行结果的回调。 |
......@@ -579,7 +579,7 @@ injectGesture(gesturePath: GesturePath, callback: AsyncCallback\<void>): void
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ---------------------------------------- |
| 9300003 | Do not have accessibility right for this operation. |
**示例：**
......@@ -621,7 +621,7 @@ attributeNames\<T extends keyof ElementAttributeValues>(): Promise\<Array\<T>>;
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ----------------------------- | ------------------------ |
| Promise&lt;Array&lt;T&gt;&gt; | Promise对象，返回节点元素的所有属性名称。 |
**示例：**
......@@ -647,7 +647,7 @@ attributeNames\<T extends keyof ElementAttributeValues>(callback: AsyncCallback\
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| -------- | ----------------------------------- | ---- | ------------------- |
| callback | AsyncCallback&lt;Array&lt;T&gt;&gt; | 是 | 回调函数，返回节点元素的所有属性名称。 |
**示例：**
......@@ -675,13 +675,13 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T): Promi
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| ------------- | ---- | ---- | -------- |
| attributeName | T | 是 | 表示属性的名称。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ---------------------------------------- | --------------------------- |
| Promise&lt;ElementAttributeValues[T]&gt; | Promise对象，返回根据节点属性名称获取的属性值。 |
**错误码：**
......@@ -689,7 +689,7 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T): Promi
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**示例：**
......@@ -721,7 +721,7 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T,
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| ------------- | ---------------------------------------- | ---- | ---------------------- |
| attributeName | T | 是 | 表示属性的名称。 |
| callback | AsyncCallback&lt;ElementAttributeValues[T]&gt; | 是 | 回调函数，返回根据节点属性名称获取的属性值。 |
......@@ -730,7 +730,7 @@ attributeValue\<T extends keyof ElementAttributeValues>(attributeName: T,
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ----------------------------- |
| 9300004 | This property does not exist. |
**示例：**
......@@ -763,7 +763,7 @@ actionNames(): Promise\<Array\<string>>;
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ---------------------------------- | -------------------------- |
| Promise&lt;Array&lt;string&gt;&gt; | Promise对象，返回节点元素支持的所有操作名称。 |
**示例：**
......@@ -789,7 +789,7 @@ actionNames(callback: AsyncCallback\<Array\<string>>): void;
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| -------- | ---------------------------------------- | ---- | --------------------- |
| callback | AsyncCallback&lt;Array&lt;string&gt;&gt; | 是 | 回调函数，返回节点元素支持的所有操作名称。 |
**示例：**
......@@ -819,12 +819,12 @@ performAction(actionName: string, parameters?: object): Promise\<void>;
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| actionName | string | 是 | 表示属性的名称，取值参考[Action](./js-apis-accessibility.md#action)。
| parameters | object | 否 | 表示执行操作时所需要的参数。 |
| parameters | object | 否 | 表示执行操作时所需要的参数；当前版本暂不支持。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ------------------- | ---------------- |
| Promise&lt;void&gt; | 无返回结果的Promise对象。 |
**错误码：**
......@@ -832,7 +832,7 @@ performAction(actionName: string, parameters?: object): Promise\<void>;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例：**
......@@ -869,7 +869,7 @@ performAction(actionName: string, callback: AsyncCallback\<void>): void;
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例：**
......@@ -899,17 +899,17 @@ performAction(actionName: string, parameters: object, callback: AsyncCallback\<v
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| ---------- | ------------------------- | ---- | ---------------------------------------- |
| actionName | string | 是 | 表示属性的名称，取值参考[Action](./js-apis-accessibility.md#action)。 |
| parameters | object | 是 | 表示执行操作时所需要的参数。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，表示执行指定操作的回调。|
| parameters | object | 是 | 表示执行操作时所需要的参数；当前版本暂不支持。 |
| callback | AsyncCallback&lt;void&gt; | 是 | 回调函数，表示执行指定操作的回调。 |
**错误码：**
以下错误码的详细介绍请参见[无障碍子系统错误码](../errorcodes/errorcode-accessibility.md)。
| 错误码ID | 错误信息 |
| ------- | -------------------------------- |
| ------- | ----------------------------- |
| 9300005 | This action is not supported. |
**示例：**
......@@ -943,14 +943,14 @@ findElement(type: 'content', condition: string): Promise\<Array\<AccessibilityEl
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | ------ | ---- | ----------------------------- |
| type | string | 是 | 固定为'content', 表示查找的类型为节点元素内容。 |
| condition | string | 是 | 表示查找的条件。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ---------------------------------------- | ----------------------------- |
| Promise&lt;Array&lt;AccessibilityElement&gt;&gt; | Promise对象，返回满足指定查询关键字的所有节点元素。 |
**示例：**
......@@ -982,7 +982,7 @@ findElement(type: 'content', condition: string, callback: AsyncCallback\<Array\<
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | ---------------------------------------- | ---- | ---------------------------- |
| type | string | 是 | 固定为'content',表示查找的类型为节点元素内容。 |
| condition | string | 是 | 表示查找的条件。 |
| callback | AsyncCallback&lt;Array&lt;AccessibilityElement&gt;&gt; | 是 | 回调函数，返回满足指定查询关键字的所有节点元素。 |
......@@ -1018,14 +1018,14 @@ findElement(type: 'focusType', condition: FocusType): Promise\<AccessibilityElem
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | ----------------------- | ---- | ---------------------------------- |
| type | string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。 |
| condition | [FocusType](#focustype) | 是 | 表示查询焦点元素的类型。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ----------------------------------- | ------------------------------ |
| Promise&lt;AccessibilityElement&gt; | Promise对象，返回满足指定查询焦点元素类型的节点元素。 |
**示例：**
......@@ -1057,7 +1057,7 @@ findElement(type: 'focusType', condition: FocusType, callback: AsyncCallback\<Ac
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | ---------------------------------------- | ---- | ---------------------------------- |
| type | string | 是 | 固定为'focusType', 表示查询的类型为节点的焦点元素类型。 |
| condition | [FocusType](#focustype) | 是 | 表示查询焦点元素的类型。 |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回满足指定查询焦点元素类型的节点元素。 |
......@@ -1093,14 +1093,14 @@ findElement(type: 'focusDirection', condition: FocusDirection): Promise\<Accessi
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | --------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。 |
| condition | [FocusDirection](#focusdirection) | 是 | 表示查询下一焦点元素的方向。 |
**返回值：**
| 类型 | 说明 |
| ---------------------------------------- | ------------------------ |
| ----------------------------------- | -------------------------------- |
| Promise&lt;AccessibilityElement&gt; | Promise对象，返回满足指定查询下一焦点元素方向的节点元素。 |
**示例：**
......@@ -1132,7 +1132,7 @@ findElement(type: 'focusDirection', condition: FocusDirection, callback: AsyncCa
**参数：**
| 参数名 | 类型 | 必填 | 说明 |
| ----------- | ---------------------------------------- | ---- | -------------- |
| --------- | ---------------------------------------- | ---- | ---------------------------------------- |
| type | string | 是 | 固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。 |
| condition | [FocusDirection](#focusdirection) | 是 | 表示下一查询焦点元素的方向。 |
| callback | AsyncCallback&lt;AccessibilityElement&gt; | 是 | 回调函数，返回满足指定查询下一焦点元素方向的节点元素。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或