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

AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境，继承自ExtensionContext。

辅助功能扩展上下文模块提供辅助功能扩展的上下文环境的能力，包括允许配置辅助应用关注信息类型、查询节点信息、手势注入等。

使用说明

在使用AccessibilityExtensionContext的功能前，需要通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContext的实例。

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

class EntryAbility extends AccessibilityExtensionAbility {
  onConnect(): void {
    let axContext = this.context; 
  } 
}

ElementAttributeValues

节点元素具备的属性名称及属性值类型信息。

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

属性

名称	类型	只读	可选	说明
accessibilityFocused	boolean	否	否	表示元素是否处于无障碍焦点状态。true表示元素当前处于无障碍焦点状态，false表示元素当前不处于无障碍焦点状态，默认值为false。
accessibilityText¹²⁺	string	否	否	元素的无障碍文本信息。
bundleName	string	否	否	应用包名。
checkable	boolean	否	否	表示元素是否支持点击操作。true表示元素支持点击操作，false表示元素不支持点击操作，默认值为false。
checked	boolean	否	否	表示元素当前的可点击状态。true表示元素当前是可点击的，false表示元素当前是不可点击的，默认值为false。
children	Array<AccessibilityElement>	否	否	所有子元素。
clickable	boolean	否	否	表示元素是否可点击。true表示元素可点击，false表示元素不可点击，默认值为false。
componentId	number	否	否	元素所属的组件ID。默认值为-1。
componentType	string	否	否	元素所属的组件类型。
contents	Array<string>	否	否	内容。
currentIndex	number	否	否	当前项的索引。默认值为0。
description	string	否	否	元素的描述信息。
editable	boolean	否	否	表示元素是否可编辑。true表示元素可编辑，false表示元素不可编辑，默认值为false。
endIndex	number	否	否	屏幕最后显示项的列表索引。默认值为0。
error	string	否	否	错误状态字符串。
focusable	boolean	否	否	表示元素是否可聚焦。true表示元素可聚焦，false表示元素不可聚焦，默认值为false。
hintText	string	否	否	提示文本。
inputType	number	否	否	输入文本的类型。默认值为0。
inspectorKey	string	否	否	检查键。
isActive	boolean	否	否	表示元素是否处于活动状态。true表示元素处于活动状态，false表示元素不处于活动状态，默认值为true。
isEnable	boolean	否	否	表示元素是否启用。true表示元素已启用，false表示元素未启用，默认值为false。
isHint	boolean	否	否	表示元素是否为提示状态。true表示元素处于提示状态，false表示元素不处于提示状态，默认值为false。
isFocused	boolean	否	否	表示元素是否聚焦。true表示元素处于聚焦状态，false表示元素不处于聚焦状态，默认值为false。
isPassword	boolean	否	否	表示元素是否为密码。true表示元素为密码，false表示元素不为密码，默认值为false。
isVisible	boolean	否	否	表示元素是否可见。true表示元素可见，false表示元素不可见，默认值为false。
itemCount	number	否	否	项目的总数。默认值为0。
lastContent	string	否	否	最后的内容。
layer	number	否	否	该元素的显示层。
longClickable	boolean	否	否	表示元素是否可长单击。true表示元素可长单击，false表示元素不可长单击，默认值为false。
pageId	number	否	否	页码id。默认值为-1。
parent	AccessibilityElement	否	否	元素的父元素。
pluralLineSupported	boolean	否	否	表示元素是否支持多行文本。true表示元素支持多行文本，false表示元素不支持多行文本，默认值为false。
rect	Rect	否	否	元素的面积。
resourceName	string	否	否	元素的资源名称。
rootElement	AccessibilityElement	否	否	窗口元素的根元素。
screenRect	Rect	否	否	元素的显示区域。
scrollable	boolean	否	否	表示元素是否可滚动。true表示元素可滚动，false表示元素不可滚动，默认值为false。
selected	boolean	否	否	表示元素是否被选中。true表示元素被选中，false表示元素未被选中，默认值为false。
startIndex	number	否	否	在屏幕上的第一个项目的列表索引。默认值为0。
text	string	否	否	元素的文本。
textLengthLimit	number	否	否	元素文本的最大长度限制。
textMoveUnit	accessibility.TextMoveUnit	否	否	文本被读取时的移动单位。
triggerAction	accessibility.Action	否	否	触发元素事件的动作。
type	WindowType	否	否	元素的窗口类型。
valueMax	number	否	否	最大值。默认值为0。
valueMin	number	否	否	最小值。默认值为0。
valueNow	number	否	否	当前值。默认值为0。
windowId	number	否	否	窗口ID。默认值为-1。
textType¹²⁺	string	否	否	元素的无障碍文本类型，由组件accessibilityTextHint属性配置。
offset¹²⁺	number	是	否	对于可滚动类控件，如List、Grid，内容区相对控件的顶部坐标滚动的像素偏移量。默认值为0。
hotArea¹²⁺	Rect	否	否	元素的可触摸区域。
customComponentType¹⁸⁺	string	否	是	自定义组件类型。
accessibilityNextFocusId¹⁸⁺	number	否	是	下一个要聚焦的组件ID。通过findElement('elementId')查询到的AccessibilityElementInfo对象中可获取到用户在控件上设置的该属性值。默认值为-1。
accessibilityPreviousFocusId¹⁸⁺	number	否	是	上一个聚焦的组件ID。通过findElement('elementId')查询到的AccessibilityElementInfo对象中可获取到用户在控件上设置的该属性值。默认值为-1。
extraInfo¹⁸⁺	string	否	是	扩展属性，用于定义一些特定组件的属性，包含： - CheckboxGroupSelectedStatus：表示CheckboxGroup组件的选中状态，其中取值0表示已选中，取值1表示部分选中，取值2表示未选中。 - Row：Grid组件中聚焦item的行信息，表示该item在第几行。 - Column：Grid组件中聚焦的item的列，表示该item在第几列。 - ListItemIndex：List组件中聚焦item的行信息，表示当前该item在第几行。 - SideBarContainerStates：表示可展开类组件（SideBarContainer、Select）的展开状态，其中取值0表示收起态，取值1表示展开态。 - ToggleType：表示Toggle组件的具体类型，其中取值0表示Checkbox，取值1表示Switch，取值2表示Button。 - BindSheet：表示BindSheet组件的状态，其中取值0表示状态高，取值1表示状态中，取值2表示状态低。 - hasRegisteredHover：表示组件是否注册了onAccessibilityHover事件回调，取值为1表示组件注册了事件回调，若未注册不会使用该字段。 - direction：表示list组件的布局方向，其中取值"vertical"表示竖向，取值"horizontal"表示横向。 - expandedState：表示list组件中listItem的展开状态，其中取值"expanded"表示展开态，取值"collapsed"表示收起态。 - componentTypeDescription：组件类型详细信息，对componentType的补充描述。
accessibilityScrollable¹⁸⁺	boolean	否	是	表示无障碍模式下元素是否滚动，优先级高于scrollable。其中，true表示可滚动，false表示不可滚动，默认值为true。

FocusDirection

表示查询下一焦点元素的方向。

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

类型	说明
'up'	表示向上查询。
'down'	表示向下查询。
'left'	表示向左查询。
'right'	表示向右查询。
'forward'	表示向前查询。
'backward'	表示向后查询。

FocusType

type FocusType = 'accessibility'|'normal'

表示查询焦点元素的类型。

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

类型	说明
'accessibility'	表示无障碍的焦点类型。
'normal'	表示普通的焦点类型。

Rect

表示矩形区域。

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

名称	类型	只读	可选	说明
left	number	否	否	矩形区域的左边界。
top	number	否	否	矩形区域的上边界。
width	number	否	否	矩形区域的宽度。
height	number	否	否	矩形区域的高度。

WindowType

type WindowType = 'application'|'system'

表示窗口的类型。

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

类型	说明
'application'	表示应用窗口类型。
'system'	表示系统窗口类型。

AccessibilityExtensionContext.setTargetBundleName^(deprecated)

setTargetBundleName(targetNames: Array<string>): Promise<void>;

设置关注的目标包名，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
targetNames	Array<string>	是	设置关注应用的包名，服务接收关注应用的无障碍事件，默认接收所有应用的无障碍事件，取消关注应用则传空数组。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let targetNames = ['com.ohos.xyz'];
axContext.setTargetBundleName(targetNames).then(() => {
  console.info(`Succeeded in set target bundle names, targetNames is ${targetNames}`);
}).catch((err: BusinessError) => {
  console.error(`failed to set target bundle names, Code is ${err.code}, message is ${err.message}`);
})

AccessibilityExtensionContext.setTargetBundleName^(deprecated)

setTargetBundleName(targetNames: Array<string>, callback: AsyncCallback<void>): void;

设置关注的目标包名，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
targetNames	Array<string>	是	设置关注应用的包名，服务接收关注应用的无障碍事件，默认接收所有应用的无障碍事件，取消关注应用则传空数组。
callback	AsyncCallback<void>	是	回调函数，如果设置关注的目标包名失败，则AsyncCallback中err有数据返回。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let targetNames = ['com.ohos.xyz'];
try {
  axContext.setTargetBundleName(targetNames, (err: BusinessError) => {
    if (err && err.code) {
      console.error(`failed to set target bundle names, Code is ${err.code}, message is ${err.message}`);
      return;
    }
    console.info(`Succeeded in set target bundle names, targetNames is ${targetNames}`);
  });
} catch (error) {
  console.error(`failed to set target bundle names, Because ${JSON.stringify(error)}`);
}

AccessibilityExtensionContext.getFocusElement^(deprecated)

getFocusElement(isAccessibilityFocus?: boolean): Promise<AccessibilityElement>;

获取焦点元素, 使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
isAccessibilityFocus	boolean	否	获取的是否是无障碍焦点元素，true表示是，false表示否，默认为否。

返回值：

类型	说明
Promise<AccessibilityElement>	Promise对象，返回当前对应的焦点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let rootElement: AccessibilityElement;

axContext.getFocusElement().then((data: AccessibilityElement) => {
  rootElement = data;
  console.log(`Succeeded in get focus element,${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get focus element, Code is ${err.code}, message is ${err.message}`);
})

AccessibilityExtensionContext.getFocusElement^(deprecated)

getFocusElement(callback: AsyncCallback<AccessibilityElement>): void;

获取焦点元素, 使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回当前对应的焦点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let rootElement: AccessibilityElement;

axContext.getFocusElement((err: BusinessError, data: AccessibilityElement) => {
  if (err && err.code) {
    console.error(`failed to get focus element, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  rootElement = data;
  console.info(`Succeeded in get focus element, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.getFocusElement^(deprecated)

getFocusElement(isAccessibilityFocus: boolean, callback: AsyncCallback<AccessibilityElement>): void;

获取焦点元素, 使用callback异步回调。

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

参数：

参数名	类型	必填	说明
isAccessibilityFocus	boolean	是	获取的是否是无障碍焦点元素，True表示是，False表示否。
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回当前对应的焦点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let isAccessibilityFocus = true;
let rootElement: AccessibilityElement;

axContext.getFocusElement(isAccessibilityFocus, (err: BusinessError, data: AccessibilityElement)=> {
  if (err && err.code) {
    console.error(`failed to get focus element, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  rootElement = data;
  console.info(`Succeeded in get focus element, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

getWindowRootElement(windowId?: number): Promise<AccessibilityElement>;

获取指定窗口的根节点元素, 使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
windowId	number	否	指定窗口的编号，未指定则从当前活跃窗口获取。

返回值：

类型	说明
Promise<AccessibilityElement>	Promise对象，返回指定窗口的根节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let rootElement: AccessibilityElement;

axContext.getWindowRootElement().then((data: AccessibilityElement) => {
  rootElement = data;
  console.log(`Succeeded in get root element of the window, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get root element of the window, Code is ${err.code}, message is ${err.message}`);
});

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

getWindowRootElement(callback: AsyncCallback<AccessibilityElement>): void;

获取指定窗口的根节点元素, 使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回指定窗口的根节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let rootElement: AccessibilityElement;

axContext.getWindowRootElement((err: BusinessError, data: AccessibilityElement) => {
  if (err && err.code) {
    console.error(`failed to get root element of the window, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  rootElement = data;
  console.info(`Succeeded in get root element of the window, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

getWindowRootElement(windowId: number, callback: AsyncCallback<AccessibilityElement>): void;

获取指定窗口的根节点元素, 使用callback异步回调。

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

参数：

参数名	类型	必填	说明
windowId	number	是	指定窗口的编号，未指定则从当前活跃窗口获取。
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回指定窗口的根节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let windowId = 10;
let rootElement: AccessibilityElement;

axContext.getWindowRootElement(windowId, (err: BusinessError, data: AccessibilityElement) => {
  if (err && err.code) {
    console.error(`failed to get root element of the window, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  rootElement = data;
  console.info(`Succeeded in get root element of the window, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.getWindows^(deprecated)

getWindows(displayId?: number): Promise<Array<AccessibilityElement>>;

获取指定屏幕中的所有窗口，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
displayId	number	否	指定的屏幕编号，未指定则从默认主屏幕获取。

返回值：

类型	说明
Promise<Array<AccessibilityElement>>	Promise对象，返回指定屏幕的所有窗口。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

axContext.getWindows().then((data: AccessibilityElement[]) => {
  console.log(`Succeeded in get windows, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get windows, Code is ${err.code}, message is ${err.message}`);
});

AccessibilityExtensionContext.getWindows^(deprecated)

getWindows(callback: AsyncCallback<Array<AccessibilityElement>>): void;

获取指定屏幕中的所有窗口，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<AccessibilityElement>>	是	回调函数，返回指定屏幕的所有窗口。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

axContext.getWindows((err: BusinessError, data: AccessibilityElement[]) => {
  if (err && err.code) {
    console.error(`failed to get windows, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get windows, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.getWindows^(deprecated)

getWindows(displayId: number, callback: AsyncCallback<Array<AccessibilityElement>>): void;

获取指定屏幕中的所有窗口，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
displayId	number	是	指定的屏幕编号，未指定则从默认主屏幕获取。
callback	AsyncCallback<Array<AccessibilityElement>>	是	回调函数，返回指定屏幕的所有窗口。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

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

let displayId = 10;
axContext.getWindows(displayId, (err: BusinessError, data: AccessibilityElement[]) => {
  if (err && err.code) {
    console.error(`failed to get windows, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get windows, ${JSON.stringify(data)}`);
});

AccessibilityExtensionContext.injectGesture^(deprecated)

injectGesture(gesturePath: GesturePath): Promise<void>;

注入手势，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
gesturePath	GesturePath	是	表示手势的路径信息。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

import { GesturePath, GesturePoint } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let gesturePath: GesturePath = new GesturePath(100);

for (let i = 0; i < 10; i++) {
  let gesturePoint = new GesturePoint(100, i * 200);
  gesturePath.points.push(gesturePoint);
}
axContext.injectGesture(gesturePath).then(() => {
  console.info(`Succeeded in inject gesture,gesturePath is ${gesturePath}`);
}).catch((err: BusinessError) => {
  console.error(`failed to inject gesture, Code is ${err.code}, message is ${err.message}`);
});

AccessibilityExtensionContext.injectGesture^(deprecated)

injectGesture(gesturePath: GesturePath, callback: AsyncCallback<void>): void

注入手势，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
gesturePath	GesturePath	是	表示手势的路径信息。
callback	AsyncCallback<void>	是	回调函数，表示注入手势执行结果的回调。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

import { GesturePath, GesturePoint } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let gesturePath: GesturePath = new GesturePath(100);
for (let i = 0; i < 10; i++) {
  let gesturePoint = new GesturePoint(100, i * 200);
  gesturePath.points.push(gesturePoint);
}
axContext.injectGesture(gesturePath, (err: BusinessError) => {
  if (err) {
    console.error(`failed to inject gesture, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in inject gesture,gesturePath is ${gesturePath}`);
});

AccessibilityExtensionContext.injectGestureSync^(deprecated)

injectGestureSync(gesturePath: GesturePath): void

注入手势。

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

参数：

参数名	类型	必填	说明
gesturePath	GesturePath	是	表示手势的路径信息。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300003	No accessibility permission to perform the operation.

示例：

import { GesturePath, GesturePoint } from '@kit.AccessibilityKit';

let gesturePath: GesturePath = new GesturePath(100);
for (let i = 0; i < 10; i++) {
  let gesturePoint = new GesturePoint(100, i * 200);
  gesturePath.points.push(gesturePoint);
}
axContext.injectGestureSync(gesturePath);

AccessibilityElement⁹⁺

无障碍节点元素, 在调用AccessibilityElement的方法前，需要先通过AccessibilityExtensionContext.getFocusElement() 或者AccessibilityExtensionContext.getWindowRootElement() 获取AccessibilityElement实例。

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

attributeNames^(deprecated)

attributeNames<T extends keyof ElementAttributeValues>() : Promise<Array<T>>;

获取节点元素的所有属性名称，使用Promise异步回调。

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

返回值：

类型	说明
Promise<Array<T>>	Promise对象，返回节点元素的所有属性名称。

示例：

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

// rootElement是AccessibilityElement的实例
rootElement.attributeNames().then((data: ElementAttributeKeys[]) => {
  console.log(`Succeeded in get attribute names, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.log(`failed to get attribute names, Code is ${err.code}, message is ${err.message}`);
});

attributeNames^(deprecated)

attributeNames<T extends keyof ElementAttributeValues>(callback: AsyncCallback<Array<T>>): void;

获取节点元素的所有属性名称，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<T>>	是	回调函数，返回节点元素的所有属性名称。

示例：

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

// rootElement是AccessibilityElement的实例
rootElement.attributeNames((err: BusinessError, data: ElementAttributeKeys[]) => {
  if (err && err.code) {
    console.error(`failed to get attribute names, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get attribute names, ${JSON.stringify(data)}`);
});

attributeValue^(deprecated)

attributeValue<T extends keyof ElementAttributeValues>(attributeName: T): Promise<ElementAttributeValues[T]>;

根据属性名称获取属性值，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
attributeName	ElementAttributeKeys	是	表示属性的名称。

返回值：

类型	说明
Promise<ElementAttributeValues[T]>	Promise对象，返回根据节点属性名称获取的属性值。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300004	This property does not exist.

示例：

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

let attributeName: ElementAttributeKeys = 'bundleName';

// rootElement是AccessibilityElement的实例
rootElement.attributeValue(attributeName).then((data: string) => {
  console.log(`Succeeded in get attribute value by name, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get attribute value, Code is ${err.code}, message is ${err.message}`);
});

attributeValue^(deprecated)

attributeValue<T extends keyof ElementAttributeValues>(attributeName: T, callback: AsyncCallback<ElementAttributeValues[T]>): void;

根据属性名称获取属性值，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
attributeName	ElementAttributeKeys	是	表示属性的名称。
callback	AsyncCallback<ElementAttributeValues[T]>	是	回调函数，返回根据节点属性名称获取的属性值。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300004	This property does not exist.

示例：

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

let attributeName: ElementAttributeKeys = 'bundleName';

// rootElement是AccessibilityElement的实例
rootElement.attributeValue(attributeName, (err: BusinessError, data: string) => {
  if (err && err.code) {
    console.error(`failed to get attribute value, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get attribute value, ${JSON.stringify(data)}`);
});

actionNames^(deprecated)

actionNames(): Promise<Array<string>>;

获取节点元素支持的所有操作名称，使用Promise异步回调。

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

返回值：

类型	说明
Promise<Array<string>>	Promise对象，返回节点元素支持的所有操作名称。

示例：

import { BusinessError } from '@kit.BasicServicesKit';

// rootElement是AccessibilityElement的实例
rootElement.actionNames().then((data: string[]) => {
  console.log(`Succeeded in get action names, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get action names, Code is ${err.code}, message is ${err.message}`);
})

actionNames^(deprecated)

actionNames(callback: AsyncCallback<Array<string>>): void;

获取节点元素支持的所有操作名称，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback<Array<string>>	是	回调函数，返回节点元素支持的所有操作名称。

示例：

// rootElement是AccessibilityElement的实例
rootElement.actionNames((err: BusinessError, data: string[]) => {
  if (err && err.code) {
    console.error(`failed to get action names, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get action names, ${JSON.stringify(data)}`);
})

performAction^(deprecated)

performAction(actionName: string, parameters?: object): Promise<void>;

根据操作名称执行某个操作，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
actionName	string	是	表示属性的名称，取值参考Action。
parameters	object	否	表示执行操作时所需要的参数；默认为空。

返回值：

类型	说明
Promise<void>	无返回结果的Promise对象。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300005	This action is not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let actionName = 'action';

// rootElement是AccessibilityElement的实例
rootElement.performAction(actionName).then(() => {
  console.info(`Succeeded in perform action,actionName is ${actionName}`);
}).catch((err: BusinessError) => {
  console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
});

无参数Action示例：

import { BusinessError } from '@kit.BasicServicesKit';

// rootElement是AccessibilityElement的实例
// Action描述中无明确要求的，均为无参数Action
rootElement.performAction('click').then(() => {
  console.info(`Succeeded in perform action.`);
}).catch((err: BusinessError) => {
  console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
});

有参数Action示例：

import { BusinessError } from '@kit.BasicServicesKit';

// rootElement是AccessibilityElement的实例
// setSelection示例代码
rootElement.performAction('setSelection', {
  selectTextBegin: '0', // 表示选择起始位置
  selectTextEnd: '8',   // 表示选择结束位置
  selectTextInForWard: true   // true表示为前光标，false表示为后光标
}).then(() => {
  console.info(`Succeeded in perform action`);
}).catch((err: BusinessError) => {
  console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
});

import { BusinessError } from '@kit.BasicServicesKit';

// rootElement是AccessibilityElement的实例
// setCursorPosition示例代码
rootElement.performAction('setCursorPosition', {
  offset: '1'   // 表示光标的设置位置
}).then(() => {
  console.info(`Succeeded in perform action`);
}).catch((err: BusinessError) => {
  console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
});

performAction^(deprecated)

performAction(actionName: string, callback: AsyncCallback<void>): void;

根据操作名称执行某个操作，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
actionName	string	是	表示属性的名称，取值参考Action。
callback	AsyncCallback<void>	是	回调函数，表示执行指定操作的回调。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300005	This action is not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let actionName = 'action';

// rootElement是AccessibilityElement的实例
rootElement.performAction(actionName, (err: BusinessError) => {
  if (err && err.code) {
    console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in perform action, actionName is ${actionName}`);
});

performAction^(deprecated)

performAction(actionName: string, parameters: object, callback: AsyncCallback<void>): void;

根据操作名称执行某个操作，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
actionName	string	是	表示属性的名称，取值参考Action。
parameters	object	是	表示执行操作时所需要的参数；默认为空。
callback	AsyncCallback<void>	是	回调函数，表示执行指定操作的回调。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.
9300005	This action is not supported.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let actionName = 'action';
let parameters: object = [];

// rootElement是AccessibilityElement的实例
rootElement.performAction(actionName, parameters, (err: BusinessError) => {
  if (err && err.code) {
    console.error(`failed to perform action, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in perform action,actionName is ${actionName}, parameters is ${parameters}`);
});

findElement('content')^(deprecated)

findElement(type: 'content', condition: string): Promise<Array<AccessibilityElement>>;

根据节点内容查询所有节点元素，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'content', 表示查找的类型为节点元素内容。
condition	string	是	表示查找的条件。

返回值：

类型	说明
Promise<Array<AccessibilityElement>>	Promise对象，返回满足指定查询关键字的所有节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let condition = 'keyword';

// rootElement是AccessibilityElement的实例
rootElement.findElement('content', condition).then((data: AccessibilityElement[]) => {
  console.log(`Succeeded in find element, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
});

findElement('content')^(deprecated)

findElement(type: 'content', condition: string, callback: AsyncCallback<Array<AccessibilityElement>>): void;

根据节点内容查询所有节点元素。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'content',表示查找的类型为节点元素内容。
condition	string	是	表示查找的条件。
callback	AsyncCallback<Array<AccessibilityElement>>	是	回调函数，返回满足指定查询关键字的所有节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

import { BusinessError } from '@kit.BasicServicesKit';

let condition = 'keyword';

// rootElement是AccessibilityElement的实例
rootElement.findElement('content', condition, (err: BusinessError, data: AccessibilityElement[])=>{
  if (err && err.code) {
    console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in find element, ${JSON.stringify(data)}`);
});

findElement('focusType')^(deprecated)

findElement(type: 'focusType', condition: FocusType): Promise<AccessibilityElement>;

根据焦点元素类型查询节点元素，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'focusType'，表示查询的类型为节点的焦点元素类型。
condition	FocusType	是	表示查询焦点元素的类型。

返回值：

类型	说明
Promise<AccessibilityElement>	Promise对象，返回满足指定查询焦点元素类型的节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

let condition: FocusType = 'normal';

// rootElement是AccessibilityElement的实例
rootElement.findElement('focusType', condition).then((data: AccessibilityElement) => {
  console.log(`Succeeded in find element,${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
});

findElement('focusType')^(deprecated)

findElement(type: 'focusType', condition: FocusType, callback: AsyncCallback<AccessibilityElement>): void;

根据焦点元素类型查询节点元素，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'focusType'，表示查询的类型为节点的焦点元素类型。
condition	FocusType	是	表示查询焦点元素的类型。
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回满足指定查询焦点元素类型的节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

let condition: FocusType = 'normal';

// rootElement是AccessibilityElement的实例
rootElement.findElement('focusType', condition, (err: BusinessError, data: AccessibilityElement)=>{
  if (err && err.code) {
    console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in find element, ${JSON.stringify(data)}`);
});

findElement('focusDirection')^(deprecated)

findElement(type: 'focusDirection', condition: FocusDirection): Promise<AccessibilityElement>;

根据下一焦点元素方向查询节点元素，使用Promise异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'focusDirection'，表示查询的类型为节点的下一焦点元素方向。
condition	FocusDirection	是	表示查询下一焦点元素的方向。

返回值：

类型	说明
Promise<AccessibilityElement>	Promise对象，返回满足指定查询下一焦点元素方向的节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

let condition: FocusDirection = 'up';

// rootElement是AccessibilityElement的实例
rootElement.findElement('focusDirection', condition).then((data: AccessibilityElement) => {
  console.log(`Succeeded in find element, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
});

findElement('focusDirection')^(deprecated)

findElement(type: 'focusDirection', condition: FocusDirection, callback: AsyncCallback<AccessibilityElement>): void;

根据下一焦点元素方向查询节点元素，使用callback异步回调。

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

参数：

参数名	类型	必填	说明
type	string	是	固定为'focusDirection', 表示查询的类型为节点的下一焦点元素方向。
condition	FocusDirection	是	表示下一查询焦点元素的方向。
callback	AsyncCallback<AccessibilityElement>	是	回调函数，返回满足指定查询下一焦点元素方向的节点元素。

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

错误码ID	错误信息
401	Input parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed.

示例：

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

let condition: FocusDirection = 'up';

// rootElement是AccessibilityElement的实例
rootElement.findElement('focusDirection', condition, (err: BusinessError, data: AccessibilityElement) =>{
  if (err && err.code) {
    console.error(`failed to find element, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in find element, ${JSON.stringify(data)}`);
});

你可能感兴趣的鸿蒙文章

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

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

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

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

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

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

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

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

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

使用说明

ElementAttributeValues

属性

FocusDirection

FocusType

Rect

WindowType

AccessibilityExtensionContext.setTargetBundleName(deprecated)

AccessibilityExtensionContext.setTargetBundleName(deprecated)

AccessibilityExtensionContext.getFocusElement(deprecated)

AccessibilityExtensionContext.getFocusElement(deprecated)

AccessibilityExtensionContext.getFocusElement(deprecated)

AccessibilityExtensionContext.getWindowRootElement(deprecated)

AccessibilityExtensionContext.getWindowRootElement(deprecated)

AccessibilityExtensionContext.getWindowRootElement(deprecated)

AccessibilityExtensionContext.getWindows(deprecated)

AccessibilityExtensionContext.getWindows(deprecated)

AccessibilityExtensionContext.getWindows(deprecated)

AccessibilityExtensionContext.injectGesture(deprecated)

AccessibilityExtensionContext.injectGesture(deprecated)

AccessibilityExtensionContext.injectGestureSync(deprecated)

AccessibilityElement9+

attributeNames(deprecated)

attributeNames(deprecated)

attributeValue(deprecated)

attributeValue(deprecated)

actionNames(deprecated)

actionNames(deprecated)

performAction(deprecated)

performAction(deprecated)

performAction(deprecated)

findElement('content')(deprecated)

findElement('content')(deprecated)

findElement('focusType')(deprecated)

findElement('focusType')(deprecated)

findElement('focusDirection')(deprecated)

findElement('focusDirection')(deprecated)

你可能感兴趣的鸿蒙文章

标签云

最热博客

最新博客

AccessibilityExtensionContext.setTargetBundleName^(deprecated)

AccessibilityExtensionContext.setTargetBundleName^(deprecated)

AccessibilityExtensionContext.getFocusElement^(deprecated)

AccessibilityExtensionContext.getFocusElement^(deprecated)

AccessibilityExtensionContext.getFocusElement^(deprecated)

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

AccessibilityExtensionContext.getWindowRootElement^(deprecated)

AccessibilityExtensionContext.getWindows^(deprecated)

AccessibilityExtensionContext.getWindows^(deprecated)

AccessibilityExtensionContext.getWindows^(deprecated)

AccessibilityExtensionContext.injectGesture^(deprecated)

AccessibilityExtensionContext.injectGesture^(deprecated)

AccessibilityExtensionContext.injectGestureSync^(deprecated)

AccessibilityElement⁹⁺

attributeNames^(deprecated)

attributeNames^(deprecated)

attributeValue^(deprecated)

attributeValue^(deprecated)

actionNames^(deprecated)

actionNames^(deprecated)

performAction^(deprecated)

performAction^(deprecated)

performAction^(deprecated)

findElement('content')^(deprecated)

findElement('content')^(deprecated)

findElement('focusType')^(deprecated)

findElement('focusType')^(deprecated)

findElement('focusDirection')^(deprecated)

findElement('focusDirection')^(deprecated)