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

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

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

说明：

• 本模块首批接口从API version 12开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 当前页面仅包含本模块的系统接口，其他公开接口请参AccessibilityExtensionContext (辅助功能扩展上下文)。

使用说明

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

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

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

enableScreenCurtain¹²⁺

enableScreenCurtain(isEnable: boolean): void;

提供开启/关闭幕帘屏的能力。

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

参数：

错误码：

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

示例：

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)}`);
  await rootElement.enableScreenCurtain(true);
  console.log(`Succeeded in enableScreenCurtain}`);
}).catch((err: BusinessError) => {
  console.error(`failed to enableScreenCurtain, Code is ${err.code}, message is ${err.message}`);
});

findElement(‘elementId’)¹²⁺

findElement(type: ‘elementId’, condition: number): Promise<AccessibilityElement>;

根据elementId查询当前活动窗口下的节点元素，使用Promise异步回调。

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

参数：

返回值：

错误码：

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

示例：

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

//elementId为10
let condition = 10;

// rootElement是AccessibilityElement的实例
rootElement.findElement('elementId', 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(‘textType’)¹²⁺

findElement(type: ‘textType’, condition: string): Promise<Array<AccessibilityElement>>;

根据节点配置的accessibilityTextHint无障碍文本类型查询所有节点元素，使用Promise异步回调。

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

参数：

返回值：

错误码：

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

示例：

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

// condition的内容需要与目标组件accessibilityTextHint属性的type字段值保持一致
let condition = 'location'; 

// rootElement是AccessibilityElement的实例
rootElement.findElement('textType', 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}`);
});

getCursorPosition¹²⁺

getCursorPosition(): Promise<number>;

获取文本组件中光标位置，使用Promise异步回调。

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

返回值：

示例：

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

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

getCursorPosition¹²⁺

getCursorPosition(callback: AsyncCallback<number>): void;

获取文本组件中光标位置，使用callback异步回调。

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

参数：

示例：

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

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

startAbility¹²⁺

startAbility(want: Want): Promise<void>;

提供拉起前台页面的能力。

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

参数：

返回值：

错误码：

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

示例：

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

let want: Want = {
  bundleName: 'com.huawei.hmos.photos'
  abilityName: 'com.huawei.hmos.photos.MainAbility'
}

axContext.startAbility(want).then(() => {
  console.info(`startAbility Succeeded enable ability`);
}).catch((err: BusinessError) => {
  console.error(`startAbility failed to enable ability, Code is ${err.code}, message is ${err.message}`);
});

AccessibilityExtensionContext.getElements¹⁸⁺

getElements(windowId: number, elementId?: number): Promise;

提供批量查询节点的能力。

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

参数：

返回值： |类型 |说明 | |———————————–|———————-| |Promise|Promise对象，返回当前窗口或者当前节点下的所有子节点列表。|

错误码：

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

示例：

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

let windowId: number = 10;
let elementId: number = 10;

axContext.getElements(windowId, elementId).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}`);
});

AccessibilityExtensionContext.getDefaultFocusedElementIds¹⁸⁺

getDefaultFocusedElementIds(windowId: number): Promise;

提供查询应用自定义默认焦点的能力。

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

参数：

返回值： |类型 |说明 | |———————————–|———————-| |Promise|Promise对象，返回当前窗口下的自定义默认焦点列表。|

错误码：

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

示例：

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

let windowId: number = 10;

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

AccessibilityExtensionContext.holdRunningLockSync²⁰⁺

holdRunningLockSync(): void

持有RunningLock锁，持锁后，屏幕不会自动灭屏。

需要权限：ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY

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

错误码：

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

示例：

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

try {
  axContext.holdRunningLockSync();
} catch (err) {
  console.error(`Failed to hold RunningLock, Code is ${err.code}, message is ${err.message}`);
}

AccessibilityExtensionContext.unholdRunningLockSync²⁰⁺

unholdRunningLockSync(): void

释放RunningLock锁，恢复自动灭屏。

需要权限：ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY

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

错误码：

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

示例：

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

try {
  axContext.unholdRunningLockSync();
} catch (err) {
  console.error(`Failed to unhold RunningLock, code is ${err.code}, message is ${err.message}`);
}

AccessibilityExtensionContext.on(‘preDisconnect’)²⁰⁺

on(type: ‘preDisconnect’, callback: Callback&lt;void&gt;): void

向无障碍服务注册回调函数，在无障碍服务关闭该无障碍扩展服务前会执行该回调函数。

此注册函数需要与notifyDisconnect配合使用，如果不调用notifyDisconnect，则默认等待30秒后，无障碍扩展服务会自动关闭。

需要权限：ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY

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

参数：

错误码：

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

示例：

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

try {
  axContext.on('preDisconnect', () => {
    console.info(`To do something before accessibilityExtension disconnect.`);
  });
} catch (err) {
  console.error(`Failed to register, code is ${err.code}, message is ${err.message}`);
}

AccessibilityExtensionContext.off(‘preDisconnect’)²⁰⁺

off(type: ‘preDisconnect’, callback?: Callback&lt;void&gt;): void

取消已经向无障碍服务注册的预关闭回调函数，无障碍服务关闭该扩展服务前不再执行该回调。

需要权限：ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY

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

参数：

错误码：

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

示例：

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

try {
  axContext.off('preDisconnect', () => {
    console.info(`To do something before accessibilityExtension disconnect.`);
  });
} catch (err) {
  console.error(`Failed to unRegister, code is ${err.code}, message is ${err.message}`);
}

AccessibilityExtensionContext.notifyDisconnect²⁰⁺

notifyDisconnect(): void

通知无障碍服务可以关闭该无障碍扩展服务。

此函数需要与注册预关闭接口on(‘preDisconnect’)配合使用，如果没有调用过注册预关闭函数，直接调用此函数不生效。

需要权限：ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY

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

错误码：

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

示例：

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

try {
  axContext.notifyDisconnect();
} catch (err) {
  console.error(`Failed to notify accessibility, code is ${err.code}, message is ${err.message}`);
}

你可能感兴趣的鸿蒙文章

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 (辅助功能扩展上下文)