@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 '@kit.AccessibilityKit';

Attributes

System capability: SystemCapability.BarrierFree.Accessibility.Core

AccessibilityEvent

Defines an accessibility event.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Attributes

AccessibilityElement¹⁰⁺

Indicates an accessibility element. For details, see AccessibilityElement.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let accessibilityElement: AccessibilityElement;

ElementAttributeValues¹⁰⁺

Provides attribute names and value types of a node element. For details, see ElementAttributeValues.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let elementAttributeValues: ElementAttributeValues;

FocusDirection¹⁰⁺

Enumerates the focus directions. For details, see FocusDirection.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let focusDirection: FocusDirection;

ElementAttributeKeys¹⁰⁺

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let elementAttributeKeys: ElementAttributeKeys;

FocusType¹⁰⁺

Enumerates the focus types. For details, see FocusType.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let focusType: FocusType;

WindowType ¹⁰⁺

Enumerates the window types. For details, see WindowType.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let windowType: WindowType;

Rect¹⁰⁺

Defines a rectangle. For details, see Rect.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

let rect: Rect;

GestureType

Enumerates gesture types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

PageUpdateType

type PageUpdateType = ‘pageContentUpdate’|‘pageStateUpdate’

Enumerates the page update types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

TouchGuideType

TouchGuideType = ‘touchBegin’|‘touchEnd’

Enumerates the touch guide event types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

AccessibilityExtensionAbility.onConnect^(deprecated)

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.

NOTE

This API is deprecated since API version 12. The substitute API is available only for system applications.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

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

AccessibilityExtensionAbility.onDisconnect^(deprecated)

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.

NOTE

This API is deprecated since API version 12. The substitute API is available only for system applications.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Example

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

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

AccessibilityExtensionAbility.onAccessibilityEvent^(deprecated)

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.

NOTE

This API is deprecated since API version 12. The substitute API is available only for system applications.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

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;

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

NOTE

This API is deprecated since API version 12. The substitute API is available only for system applications.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

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 鸿蒙Accessibility Error Codes

harmony 鸿蒙@ohos.accessibility.GesturePath (Gesture Path)

harmony 鸿蒙@ohos.accessibility.GesturePoint (Gesture Point)

harmony 鸿蒙@ohos.accessibility.config (SystemAPI)

harmony 鸿蒙@ohos.accessibility (Accessibility)

harmony 鸿蒙AccessibilityExtensionContext (System API)

harmony 鸿蒙AccessibilityExtensionContext (Accessibility Extension Context)