openharmony 鸿蒙 js-apis-application-accessibilityExtensionAbility

2025-06-12 浏览 (1)

@ohos.application.AccessibilityExtensionAbility (辅助功能扩展能力)

AccessibilityExtensionAbility基于ExtensionAbility框架，提供辅助功能业务的能力。

说明：

  • 本模块首批接口从API version 9开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit';

属性

系统能力：SystemCapability.BarrierFree.Accessibility.Core

名称类型只读可选说明
contextAccessibilityExtensionContext否否表示辅助扩展能力上下文。

AccessibilityEvent

辅助事件信息。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

属性

名称类型只读可选说明
eventTypeaccessibility.EventType |accessibility.WindowUpdateType |TouchGuideType |GestureType |PageUpdateType否否具体事件类型。
EventType：无障碍事件类型；
WindowUpdateType：窗口变化类型；TouchGuideType：触摸浏览事件类型；
GestureType：手势事件类型；
PageUpdateType：页面刷新类型。
targetAccessibilityElement否是发生事件的目标组件。
timeStampnumber否是事件时间戳，单位是毫秒。默认值为0。
elementId12+number否是主动聚焦的组件ID。默认值为0。
textAnnouncedForAccessibility12+string否是主动播报的内容。
extraInfo20+string否是针对TextArea、TextInput、SearchField、RichEdit组件，当文本内容有新增或删除时，携带的文本内容。

AccessibilityElement10+

表示无障碍节点元素，请参考AccessibilityElement。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { AccessibilityElement } from '@kit.AccessibilityKit';

let accessibilityElement: AccessibilityElement;

ElementAttributeValues10+

表示节点元素具备的属性名称及属性值类型信息，请参考ElementAttributeValues。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { ElementAttributeValues } from '@kit.AccessibilityKit';

let elementAttributeValues: ElementAttributeValues;

FocusDirection10+

表示查询下一焦点元素的方向，请参考FocusDirection。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { FocusDirection } from '@kit.AccessibilityKit';

let focusDirection: FocusDirection;

ElementAttributeKeys10+

系统能力：SystemCapability.BarrierFree.Accessibility.Core

名称类型只读可选说明
ElementAttributeKeyskeyof ElementAttributeValues否否表示ElementAttributeValues的key。

示例：

import { ElementAttributeKeys } from '@kit.AccessibilityKit';

let elementAttributeKeys: ElementAttributeKeys;

FocusType10+

表示查询焦点元素的类型，请参考FocusType。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { FocusType } from '@kit.AccessibilityKit';

let focusType: FocusType;

WindowType 10+

表示窗口的类型，请参考WindowType。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { WindowType } from '@kit.AccessibilityKit';

let windowType: WindowType;

Rect10+

表示矩形区域，请参考Rect。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { Rect } from '@kit.AccessibilityKit';

let rect: Rect;

GestureType

手势事件类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

名称类型描述
leftstring表示向左的手势。
leftThenRightstring表示先向左再向右的手势。
leftThenUpstring表示先向左再向上的手势。
leftThenDownstring表示先向左再向下的手势。
rightstring表示向右的手势。
rightThenLeftstring表示先向右再向左的手势。
rightThenUpstring表示先向右再向上的手势。
rightThenDownstring表示先向右再向下的手势。
upstring表示向上的手势。
upThenLeftstring表示先向上再向左的手势。
upThenRightstring表示先向上再向右的手势。
upThenDownstring表示先向上再向下的手势。
downstring表示向下的手势。
downThenLeftstring表示先向下再向左的手势。
downThenRightstring表示先向下再向右的手势。
downThenUpstring表示先向下再向上的手势。
twoFingerSingleTap11+string表示双指单击的手势。
twoFingerDoubleTap11+string表示双指双击的手势。
twoFingerDoubleTapAndHold11+string表示双指双击长按的手势。
twoFingerTripleTap11+string表示双指三击的手势。
twoFingerTripleTapAndHold11+string表示双指三击长按的手势。
threeFingerSingleTap11+string表示三指单击的手势。
threeFingerDoubleTap11+string表示三指双击的手势。
threeFingerDoubleTapAndHold11+string表示三指双击长按的手势。
threeFingerTripleTap11+string表示三指三击的手势。
threeFingerTripleTapAndHold11+string表示三指三击长按的手势。
fourFingerSingleTap11+string表示四指单击的手势。
fourFingerDoubleTap11+string表示四指双击的手势。
fourFingerDoubleTapAndHold11+string表示四指双击长按的手势。
fourFingerTripleTap11+string表示四指三击的手势。
fourFingerTripleTapAndHold11+string表示四指三击长按的手势。
threeFingerSwipeUp11+string表示三指向上滑动的手势。
threeFingerSwipeDown11+string表示三指向下滑动的手势。
threeFingerSwipeLeft11+string表示三指向左滑动的手势。
threeFingerSwipeRight11+string表示三指向右滑动的手势。
fourFingerSwipeUp11+string表示四指向上滑动的手势。
fourFingerSwipeDown11+string表示四指向下滑动的手势。
fourFingerSwipeLeft11+string表示四指向左滑动的手势。
fourFingerSwipeRight11+string表示四指向右滑动的手势。

PageUpdateType

type PageUpdateType = 'pageContentUpdate'|'pageStateUpdate'

页面刷新类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

类型说明
'pageContentUpdate'表示页面内容刷新。
'pageStateUpdate'表示页面状态刷新。

TouchGuideType

TouchGuideType = 'touchBegin'|'touchEnd'

触摸浏览事件类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

类型说明
'touchBegin'表示触摸浏览时开始触摸。
'touchEnd'表示触摸浏览时结束触摸。

AccessibilityExtensionAbility.onConnect(deprecated)

onConnect(): void;

用户启用AccessibilityExtensionAbility时，系统服务完成连接后，回调此接口，可以该方法中执行初始化业务逻辑操作。该方法可以选择性重写。

说明：

从API version 12开始废弃。替代接口仅面向系统应用开放。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit';

class MyAccessibilityExtensionAbility extends AccessibilityExtensionAbility {
  onConnect(): void {
    console.log('AxExtensionAbility onConnect');
  }
}

AccessibilityExtensionAbility.onDisconnect(deprecated)

onDisconnect(): void;

用户停用AccessibilityExtensionAbility时，系统服务完成断开连接后，回调此接口，可以该方法中执行资源回收退出业务逻辑操作。该方法可以选择性重写。

说明：

从API version 12开始废弃。替代接口仅面向系统应用开放。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

示例：

import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit';

class MyAccessibilityExtensionAbility extends AccessibilityExtensionAbility {
  onDisconnect(): void {
    console.log('AxExtensionAbility onDisconnect');
  }
}

AccessibilityExtensionAbility.onAccessibilityEvent(deprecated)

onAccessibilityEvent(event: AccessibilityEvent): void;

在关注的应用及事件类型对应的事件发生时回调此接口，可以在该方法中根据事件信息进行业务逻辑处理。一般情况下需要重写该方法完成业务。

说明：

从API version 12开始废弃。替代接口仅面向系统应用开放。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

参数名类型必填说明
eventAccessibilityEvent是无障碍事件。无返回值。

示例：

import { AccessibilityExtensionAbility, AccessibilityEvent } from '@kit.AccessibilityKit';

class MyAccessibilityExtensionAbility extends AccessibilityExtensionAbility {
  onAccessibilityEvent(event: AccessibilityEvent): void {
    console.log('AxExtensionAbility onAccessibilityEvent');
    if (event.eventType === 'click') {
      console.log('AxExtensionAbility onAccessibilityEvent: click');
    }
  }
}

AccessibilityExtensionAbility.onKeyEvent(deprecated)

onKeyEvent(keyEvent: KeyEvent): boolean;

在物理按键按下时回调此方法，可以在该方法中根据业务判断是否对事件进行拦截。

说明：

从API version 12开始废弃。替代接口仅面向系统应用开放。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

参数名类型必填说明
keyEventKeyEvent是按键事件回调函数。返回true表示拦截此按键。

示例：

import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit';
import { KeyEvent } from '@kit.InputKit';

class MyAccessibilityExtensionAbility extends AccessibilityExtensionAbility {
  onKeyEvent(keyEvent: KeyEvent): boolean {
    console.log('AxExtensionAbility onKeyEvent');
    if (keyEvent.key.code === 16) {
      console.log('AxExtensionAbility onKeyEvent: intercept 16');
      return true;
    }
    return false;
  }
}

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Accessibility Kit（无障碍开发服务）

harmony 鸿蒙无障碍子系统错误码

harmony 鸿蒙@ohos.accessibility.GesturePath (手势路径)

harmony 鸿蒙@ohos.accessibility.GesturePoint (手势触摸点)

harmony 鸿蒙@ohos.accessibility.config (系统辅助功能配置)(系统接口)

harmony 鸿蒙@ohos.accessibility (辅助功能)

harmony 鸿蒙AccessibilityExtensionContext (辅助功能扩展上下文)(系统接口)

harmony 鸿蒙AccessibilityExtensionContext (辅助功能扩展上下文)

  • 所属分类： 后端技术
  • 本文标签： 鸿蒙 软件
  • 版权声明： 本文链接 https://seaxiang.com/blog/ierkvo