@ohos.accessibility (Accessibility)

The Accessibility module implements the accessibility functions, including obtaining the accessibility application list, accessibility application enabled status, and captions configuration.

NOTE

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

Modules to Import

import accessibility from '@ohos.accessibility';

AbilityState

Enumerates the states of an accessibility application.

System capability: SystemCapability.BarrierFree.Accessibility.Core

AbilityType

Enumerates the types of accessibility applications.

System capability: SystemCapability.BarrierFree.Accessibility.Core

AccessibilityAbilityInfo

Provides information about an accessibility application.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Attributes

Action

Describes the target action supported by an accessibility application.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Capability

Enumerates the capabilities of an accessibility application.

System capability: SystemCapability.BarrierFree.Accessibility.Core

CaptionsFontEdgeType⁸⁺

Enumerates the font edge types of captions.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsFontFamily⁸⁺

Enumerates the font families of captions.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsStyle⁸⁺

Describes the style of captions.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

CaptionsManager⁸⁺

Implements configuration management for captions. Before calling any API of CaptionsManager, you must use the accessibility.getCaptionsManager() API to obtain a CaptionsManager instance.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Attributes

For a boolean return value, True means that the feature is enabled, and False means the opposite.

on('enableChange')

on(type: 'enableChange', callback: Callback<boolean>): void;

Enables listening for the enabled status changes of captions configuration. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Parameters

Example

import accessibility from '@ohos.accessibility';

let captionsManager = accessibility.getCaptionsManager();
captionsManager.on('enableChange', (data: boolean) => {
  console.info(`subscribe caption manager enable state change, result: ${JSON.stringify(data)}`);
})

on('styleChange')

on(type: 'styleChange', callback: Callback<CaptionsStyle>): void;

Enables listening for captions style changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Parameters

Example

import accessibility from '@ohos.accessibility';

let captionsManager = accessibility.getCaptionsManager();

captionsManager.on('styleChange', (data: accessibility.CaptionsStyle) => {
  console.info(`subscribe caption manager style state change, result: ${JSON.stringify(data)}`);
});

off('enableChange')

off(type: 'enableChange', callback?: Callback<boolean>): void;

Disables listening for the enabled status changes of captions configuration. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Parameters

Example

import accessibility from '@ohos.accessibility';

let captionsManager = accessibility.getCaptionsManager();

captionsManager.off('enableChange', (data: boolean) => {
  console.info(`Unsubscribe caption manager enable state change, result: ${JSON.stringify(data)}`);
});

off('styleChange')

off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void;

Disables listening for captions style changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Parameters

Example

import accessibility from '@ohos.accessibility';

let captionsManager = accessibility.getCaptionsManager();

captionsManager.off('styleChange', (data: accessibility.CaptionsStyle) => {
  console.info(`Unsubscribe caption manager style state change, result: ${JSON.stringify(data)}`);
});

EventInfo

Describes a GUI change event.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Attributes

constructor

constructor(jsonObject)

Implements a constructor.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';

let eventInfo: accessibility.EventInfo = ({
  type: 'click',
  bundleName: 'com.example.MyApplication',
  triggerAction: 'click',
});

constructor¹¹⁺

constructor(type: EventType, bundleName: string, triggerAction: Action)

Implements a constructor.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';

let eventInfo = new accessibility.EventInfo('click', 'com.example.MyApplication', 'click');

EventType

Enumerates accessibility event types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

TextMoveUnit

Enumerates the movement units for traversing the node text.

System capability: SystemCapability.BarrierFree.Accessibility.Core

WindowUpdateType

Enumerates window update types.

System capability: SystemCapability.BarrierFree.Accessibility.Core

accessibility.getAbilityLists^(deprecated)

getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>>

Obtains the accessibility application list. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use accessibility.getAccessibilityExtensionList() instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let abilityType: accessibility.AbilityType = 'spoken';
let abilityState: accessibility.AbilityState = 'enable';

accessibility.getAbilityLists(abilityType, abilityState).then((data: accessibility.AccessibilityAbilityInfo[]) => {
  console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get accessibility extension list because ${JSON.stringify(err)}`);
});

accessibility.getAbilityLists^(deprecated)

getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void

Obtains the accessibility application list. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use accessibility.getAccessibilityExtensionList() instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let abilityType: accessibility.AbilityType = 'spoken';
let abilityState: accessibility.AbilityState = 'enable';

accessibility.getAbilityLists(abilityType, abilityState, (err: BusinessError, data: accessibility.AccessibilityAbilityInfo[]) => {
  if (err) {
    console.error(`failed to get accessibility extension list because ${JSON.stringify(err)}`);
    return;
  }
  console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`);
})

accessibility.getAccessibilityExtensionList⁹⁺

getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>>

Obtains the accessibility application list. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let abilityType: accessibility.AbilityType = 'spoken';
let abilityState: accessibility.AbilityState = 'enable';

accessibility.getAccessibilityExtensionList(abilityType, abilityState).then((data: accessibility.AccessibilityAbilityInfo[]) => {
  console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get accessibility extension list, Code is ${err.code}, message is ${err.message}`);
});

accessibility.getAccessibilityExtensionList⁹⁺

getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState, callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void

Obtains the accessibility application list. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let abilityType: accessibility.AbilityType = 'spoken';
let abilityState: accessibility.AbilityState = 'enable';

accessibility.getAccessibilityExtensionList(abilityType, abilityState,(err: BusinessError, data: accessibility.AccessibilityAbilityInfo[]) => {
  if (err) {
    console.error(`failed to get accessibility extension list, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`);
});

accessibility.getCaptionsManager⁸⁺

getCaptionsManager(): CaptionsManager

Obtains a CaptionsManager instance.

System capability: SystemCapability.BarrierFree.Accessibility.Hearing

Return value

Example

import accessibility from '@ohos.accessibility';

let captionsManager = accessibility.getCaptionsManager();

accessibility.on('accessibilityStateChange')

on(type: 'accessibilityStateChange', callback: Callback<boolean>): void

Enables listening for the enabled status changes of the accessibility application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';

accessibility.on('accessibilityStateChange', (data: boolean) => {
  console.info(`subscribe accessibility state change, result: ${JSON.stringify(data)}`);
});

accessibility.on('touchGuideStateChange')

on(type: 'touchGuideStateChange', callback: Callback<boolean>): void

Enables listening for the enabled status changes of the touch guide mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Vision

Parameters

Example

import accessibility from '@ohos.accessibility';

accessibility.on('touchGuideStateChange', (data: boolean) => {
  console.info(`subscribe touch guide state change, result: ${JSON.stringify(data)}`);
});

accessibility.off('accessibilityStateChange')

off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void

Disables listening for the enabled status changes of the accessibility application. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';

accessibility.off('accessibilityStateChange', (data: boolean) => {
  console.info(`Unsubscribe accessibility state change, result: ${JSON.stringify(data)}`);
});

accessibility.off('touchGuideStateChange')

off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void

Disables listening for the enabled status changes of the touch guide mode. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';

accessibility.off('touchGuideStateChange', (data: boolean) => {
  console.info(`Unsubscribe touch guide state change, result: ${JSON.stringify(data)}`);
});

accessibility.isOpenAccessibility^(deprecated)

isOpenAccessibility(): Promise<boolean>

Checks whether accessibility is enabled. This API uses a promise to return the result.

NOTE

This API is deprecated since API version 10.

You are advised to use accessibility.isOpenAccessibilitySync instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

accessibility.isOpenAccessibility().then((data: boolean) => {
  console.info(`success data:isOpenAccessibility : ${JSON.stringify(data)}`)
}).catch((err: BusinessError) => {
  console.error(`failed to  isOpenAccessibility, Code is ${err.code}, message is ${err.message}`);
});

accessibility.isOpenAccessibility^(deprecated)

isOpenAccessibility(callback: AsyncCallback<boolean>): void

Checks whether accessibility is enabled. This API uses an asynchronous callback to return the result.

NOTE

This API is deprecated since API version 10.

You are advised to use accessibility.isOpenAccessibilitySync instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

accessibility.isOpenAccessibility((err: BusinessError, data: boolean) => {
  if (err) {
    console.error(`failed to isOpenAccessibility, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`success data:isOpenAccessibility : ${JSON.stringify(data)}`);
});

accessibility.isOpenAccessibilitySync¹⁰⁺

isOpenAccessibilitySync(): boolean

Checks whether accessibility is enabled.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let status: boolean = accessibility.isOpenAccessibilitySync();

accessibility.isOpenTouchGuide^(deprecated)

isOpenTouchGuide(): Promise<boolean>

Checks whether touch guide mode is enabled. This API uses a promise to return the result.

NOTE

This API is deprecated since API version 10.

You are advised to use accessibility.isOpenTouchGuideSync instead.

System capability: SystemCapability.BarrierFree.Accessibility.Vision

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

accessibility.isOpenTouchGuide().then((data: boolean) => {
  console.info(`success data:isOpenTouchGuide : ${JSON.stringify(data)}`);
}).catch((err: BusinessError) => {
  console.error(`failed to  isOpenTouchGuide, Code is ${err.code}, message is ${err.message}`);
});

accessibility.isOpenTouchGuide^(deprecated)

isOpenTouchGuide(callback: AsyncCallback<boolean>): void

Checks whether touch guide mode is enabled. This API uses an asynchronous callback to return the result.

NOTE

This API is deprecated since API version 10.

You are advised to use accessibility.isOpenTouchGuideSync instead.

System capability: SystemCapability.BarrierFree.Accessibility.Vision

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

accessibility.isOpenTouchGuide((err: BusinessError, data: boolean) => {
  if (err) {
    console.error(`failed to isOpenTouchGuide, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`success data:isOpenTouchGuide : ${JSON.stringify(data)}`);
});

accessibility.isOpenTouchGuideSync¹⁰⁺

isOpenTouchGuideSync(): boolean

Checks whether touch guide mode is enabled.

System capability: SystemCapability.BarrierFree.Accessibility.Vision

Return value

Example

import accessibility from '@ohos.accessibility';

let status: boolean = accessibility.isOpenTouchGuideSync();

accessibility.sendEvent^(deprecated)

sendEvent(event: EventInfo): Promise<void>

Sends an accessibility event. This API uses a promise to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use accessibility.sendAccessibilityEvent() instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let eventInfo: accessibility.EventInfo = ({
  type: 'click',
  bundleName: 'com.example.MyApplication',
  triggerAction: 'click',
});

accessibility.sendEvent(eventInfo).then(() => {
  console.info(`Succeeded in send event,eventInfo is ${eventInfo}`);
}).catch((err: BusinessError) => {
  console.error(`failed to sendEvent, Code is ${err.code}, message is ${err.message}`);
});

accessibility.sendEvent^(deprecated)

sendEvent(event: EventInfo, callback: AsyncCallback<void>): void

Sends an accessibility event. This API uses an asynchronous callback to return the result.

NOTE

This API is supported since API version 7 and deprecated since API version 9. You are advised to use accessibility.sendAccessibilityEvent() instead.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let eventInfo: accessibility.EventInfo = ({
  type: 'click',
  bundleName: 'com.example.MyApplication',
  triggerAction: 'click',
});

accessibility.sendEvent(eventInfo, (err: BusinessError) => {
  if (err) {
    console.error(`failed to sendEvent, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in sendEvent, eventInfo is ${eventInfo}`);
});

accessibility.sendAccessibilityEvent⁹⁺

sendAccessibilityEvent(event: EventInfo): Promise<void>

Sends an accessibility event. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let eventInfo: accessibility.EventInfo = ({
  type: 'click',
  bundleName: 'com.example.MyApplication',
  triggerAction: 'click',
});

accessibility.sendAccessibilityEvent(eventInfo).then(() => {
  console.info(`Succeeded in send event,eventInfo is ${eventInfo}`);
}).catch((err: BusinessError) => {
  console.error(`failed to send event , Code is ${err.code}, message is ${err.message}`);
});

accessibility.sendAccessibilityEvent⁹⁺

sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback<void>): void

Sends an accessibility event. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Example

import accessibility from '@ohos.accessibility';
import { BusinessError } from '@ohos.base';

let eventInfo: accessibility.EventInfo = ({
  type: 'click',
  bundleName: 'com.example.MyApplication',
  triggerAction: 'click',
});

accessibility.sendAccessibilityEvent(eventInfo, (err: BusinessError) => {
  if (err) {
    console.error(`failed to send event, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in send event, eventInfo is ${eventInfo}`);
});