@ohos.application.AccessibilityExtensionAbility (AccessibilityExtensionAbility)

The AccessibilityExtensionAbility module provides accessibility extension capabilities based on the ExtensionAbility framework.

NOTE

The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility';

Attributes

System capability: SystemCapability.BarrierFree.Accessibility.Core

AccessibilityEvent

Defines an accessibility event.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Attributes

AccessibilityElement¹⁰⁺

Level-2 module of AccessibilityElement.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { AccessibilityElement } from '@ohos.application.AccessibilityExtensionAbility';

let accessibilityElement: AccessibilityElement;

ElementAttributeValues¹⁰⁺

Level-2 module of ElementAttributeValues.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { ElementAttributeValues } from '@ohos.application.AccessibilityExtensionAbility';

let elementAttributeValues: ElementAttributeValues;

FocusDirection¹⁰⁺

Enumerates the focus directions. It is a level-2 module of FocusDirection.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { FocusDirection } from '@ohos.application.AccessibilityExtensionAbility';

let focusDirection: FocusDirection;

ElementAttributeKeys¹⁰⁺

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { ElementAttributeKeys } from '@ohos.application.AccessibilityExtensionAbility';

let elementAttributeKeys: ElementAttributeKeys;

FocusType¹⁰⁺

Enumerates the focus types. It is a level-2 module of FocusType.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { FocusType } from '@ohos.application.AccessibilityExtensionAbility';

let focusType: FocusType;

WindowType ¹⁰⁺

Enumerates the window types. It is a level-2 module of WindowType.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { WindowType } from '@ohos.application.AccessibilityExtensionAbility';

let windowType: WindowType;

Rect¹⁰⁺

Defines a rectangle. It is a level-2 module of Rect.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import { Rect } from '@ohos.application.AccessibilityExtensionAbility';

let rect: Rect;

GestureType

Enumerates gesture types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

PageUpdateType

Enumerates the page update types. This API is not supported in the current version.

System capability: SystemCapability.BarrierFree.Accessibility.Core

TouchGuideType

Enumerates the touch guide event types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

AccessibilityExtensionAbility.onConnect

onConnect(): void;

Called when the AccessibilityExtensionAbility is enabled and connected to the system service. In this API, you can have the service logic initialized. This API can be overridden as required.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility';

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

AccessibilityExtensionAbility.onDisconnect

onDisconnect(): void;

Called when the AccessibilityExtensionAbility is disabled and disconnected from the system service. In this API, you can implement the service logic of resource release and exit. This API can be overridden as required.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility';

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

AccessibilityExtensionAbility.onAccessibilityEvent

onAccessibilityEvent(event: AccessibilityEvent): void;

Called when an event that matches the specified bundle and event type occurs. In this API, you can implement event-specific service logic. Generally, this API needs to be overridden.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import AccessibilityExtensionAbility , { AccessibilityEvent } from '@ohos.application.AccessibilityExtensionAbility';

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

AccessibilityExtensionAbility.onKeyEvent

onKeyEvent(keyEvent: KeyEvent): boolean;

Called when a physical key is pressed. In this API, you can determine whether to intercept an event based on the service.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import AccessibilityExtensionAbility from '@ohos.application.AccessibilityExtensionAbility';
import { KeyEvent } from '@ohos.multimodalInput.keyEvent';

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;
  }
}