@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

Name	Type	Readable	Writable	Description
context	AccessibilityExtensionContext	Yes	No	Context of the accessibility extension ability.

AccessibilityEvent

Defines an accessibility event.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Attributes

Name	Type	Readable	Writable	Description
eventType	accessibility.EventType |accessibility.WindowUpdateType |TouchGuideType |GestureType |PageUpdateType	Yes	No	Event type. EventType: accessibility event type. WindowUpdateType: window update type. TouchGuideType: touch guide event type. GestureType: gesture type. PageUpdateType: page update type.
target	AccessibilityElement	Yes	No	Target component where the event occurs.
timeStamp	number	Yes	No	Timestamp of the event, in milliseconds.
elementId12+	number	Yes	No	Component ID for auto-focusing.
textAnnouncedForAccessibility12+	string	Yes	No	Content for auto-broadcasting.

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

Name	Type	Readable	Writable	Description
ElementAttributeKeys	keyof ElementAttributeValues	Yes	No	Key of ElementAttributeValues.

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

Name	Type	Description
left	string	Left gesture.
leftThenRight	string	Left-then-right gesture.
leftThenUp	string	Left-then-up gesture.
leftThenDown	string	Left-then-down gesture.
right	string	Right gesture.
rightThenLeft	string	Right-then-left gesture.
rightThenUp	string	Right-then-up gesture.
rightThenDown	string	Right-then-down gesture.
up	string	Up gesture.
upThenLeft	string	Up-then-left gesture.
upThenRight	string	Up-then-right gesture.
upThenDown	string	Up-then-down gesture.
down	string	Down gesture.
downThenLeft	string	Down-then-left gesture.
downThenRight	string	Down-then-right gesture.
downThenUp	string	Down-then-up gesture.
twoFingerSingleTap11+	string	Two-finger tap gesture.
twoFingerDoubleTap11+	string	Two-finger double-tap gesture.
twoFingerDoubleTapAndHold11+	string	Two-finger double-tap and press-and-hold gesture.
twoFingerTripleTap11+	string	Two-finger triple-tap gesture.
twoFingerTripleTapAndHold11+	string	Two-finger triple-tap and press-and-hold gesture.
threeFingerSingleTap11+	string	Three-finger tap gesture.
threeFingerDoubleTap11+	string	Three-finger double-tap gesture.
threeFingerDoubleTapAndHold11+	string	Three-finger double-tap and press-and-hold gesture.
threeFingerTripleTap11+	string	Three-finger triple-tap gesture.
threeFingerTripleTapAndHold11+	string	Three-finger triple-tap and press-and-hold gesture.
fourFingerSingleTap11+	string	Four-finger tap gesture.
fourFingerDoubleTap11+	string	Four-finger double-tap gesture.
fourFingerDoubleTapAndHold11+	string	Four-finger double-tap and press-and-hold gesture.
fourFingerTripleTap11+	string	Four-finger triple-tap gesture.
fourFingerTripleTapAndHold11+	string	Four-finger triple-tap and press-and-hold gesture.
threeFingerSwipeUp11+	string	Three-finger swipe-up gesture.
threeFingerSwipeDown11+	string	Three-finger swipe-down gesture.
threeFingerSwipeLeft11+	string	Three-finger swipe-left gesture.
threeFingerSwipeRight11+	string	Three-finger swipe-right gesture.
fourFingerSwipeUp11+	string	Four-finger swipe-up gesture.
fourFingerSwipeDown11+	string	Four-finger swipe-down gesture.
fourFingerSwipeLeft11+	string	Four-finger swipe-left gesture.
fourFingerSwipeRight11+	string	Four-finger swipe-right gesture.

PageUpdateType

type PageUpdateType = 'pageContentUpdate'|'pageStateUpdate'

Enumerates the page update types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Type	Description
'pageContentUpdate'	Update of the page content.
'pageStateUpdate'	Update of the page status.

TouchGuideType

TouchGuideType = 'touchBegin'|'touchEnd'

Enumerates the touch guide event types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Type	Description
'touchBegin'	Start of touch in touch guide mode.
'touchEnd'	End of touch in touch guide mode.

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

Name	Type	Mandatory	Description
event	AccessibilityEvent	Yes	Accessibility event. No return value.

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

Name	Type	Mandatory	Description
keyEvent	KeyEvent	Yes	Key event. If true is returned, the key is intercepted.

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)