@ohos.accessibility.config (SystemAPI)

The accessibility.config module provides APIs for configuring system accessibility features, including accessibility extension, high-contrast text, mouse buttons, and captions.

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.
• The APIs provided by this module are system APIs.

Modules to Import

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

Attributes

System capability: SystemCapability.BarrierFree.Accessibility.Core

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

enableAbility

enableAbility(name: string, capability: Array<accessibility.Capability>): Promise<void>;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Enables an accessibility extension ability. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import { accessibility, config } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let name: string = 'com.ohos.example/axExtension';
let capability: accessibility.Capability[] = ['retrieve'];

config.enableAbility(name, capability).then(() => {
  console.info(`Succeeded  in enable ability, name is ${name}, capability is ${capability}`);
}).catch((err: BusinessError) => {
  console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`);
});

enableAbility

enableAbility(name: string, capability: Array<accessibility.Capability>, callback: AsyncCallback<void>): void;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Enables an accessibility extension ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import { accessibility, config } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let name: string = 'com.ohos.example/axExtension';
let capability: accessibility.Capability[] = ['retrieve'];

config.enableAbility(name, capability, (err: BusinessError) => {
  if (err) {
    console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in enable ability, name is ${name}, capability is ${capability}`); 
});

disableAbility

disableAbility(name: string): Promise<void>;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Disables an accessibility extension ability. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import { accessibility, config } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let name: string = 'com.ohos.example/axExtension';

config.disableAbility(name).then(() => {
  console.info(`Succeeded in disable ability, name is ${name}`);
}).catch((err: BusinessError) => {
  console.error(`failed to disable ability, Code is ${err.code}, message is ${err.message}`);
})

disableAbility

disableAbility(name: string, callback: AsyncCallback<void>): void;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Disables an accessibility extension ability. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

import { accessibility, config } from '@kit.AccessibilityKit';
import { BusinessError } from '@kit.BasicServicesKit';

let name: string = 'com.ohos.example/axExtension';

config.disableAbility(name, (err: BusinessError) => {
  if (err) {
    console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in disable, name is ${name}`);
});

on(‘enabledAccessibilityExtensionListChange’)

on(type: ‘enabledAccessibilityExtensionListChange’, callback: Callback<void>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Adds a listener for changes in the list of enabled accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.on('enabledAccessibilityExtensionListChange', () => {
  console.info('subscribe enabled accessibility extension list change state success');
});

off(‘enabledAccessibilityExtensionListChange’)

off(type: ‘enabledAccessibilityExtensionListChange’, callback?: Callback<void>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Cancels a listener for changes in the list of enabled accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.off('enabledAccessibilityExtensionListChange', () => {
  console.info('Unsubscribe enabled accessibility extension list change state success');
});

on(‘installedAccessibilityListChange’)¹²⁺

on(type: ‘installedAccessibilityListChange’, callback: Callback<void>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Adds a listener for changes in the list of installed accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.on('installedAccessibilityListChange', () => {
  console.info('subscribe installed accessibility extension list change state success');
});

off(‘installedAccessibilityListChange’)¹²⁺

off(type: ‘installedAccessibilityListChange’, callback?: Callback<void>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Cancels a listener for changes in the list of installed accessibility extension abilities. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.off('installedAccessibilityListChange', () => {
  console.info('Unsubscribe installed accessibility extension list change state success');
});

Config

Implements configuration, acquisition, and listening for attributes.

set

set(value: T): Promise<void>;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Sets the attribute value. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

let value: boolean = true;

config.highContrastText.set(value).then(() => {
  console.info(`Succeeded in set highContrastText value is ${value}`);
}).catch((err: BusinessError) => {
  console.error(`failed to set highContrastText, Code is ${err.code}, message is ${err.message}`);
});

set

set(value: T, callback: AsyncCallback<void>): void;

Required permissions: ohos.permission.WRITE_ACCESSIBILITY_CONFIG

Sets the attribute value. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

let value: boolean = true;

config.highContrastText.set(value, (err: BusinessError) => {
  if (err) {
    console.error(`failed to set highContrastText, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in set highContrastText, value is ${value}`);
});

get

get(): Promise<T>;

Obtains the attribute value. This API uses a promise to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Return value

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.highContrastText.get().then((data: boolean) => {
  console.info(`Succeeded in get highContrastText, data is ${data}`);
}).catch((err: BusinessError) => {
  console.error(`failed to get highContrastText, Code is ${err.code}, message is ${err.message}`);
});

get

get(callback: AsyncCallback<T>): void;

Obtains the attribute value. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.highContrastText.get((err: BusinessError, data: boolean) => {
  if (err) {
    console.error(`failed to get highContrastText, Code is ${err.code}, message is ${err.message}`);
    return;
  }
  console.info(`Succeeded in get highContrastText, data is ${data}`);
});

on

on(callback: Callback<T>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Adds a listener for attribute changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.highContrastText.on((data: boolean) => {
  console.info(`subscribe highContrastText success, result: ${JSON.stringify(data)}`);
});

off

off(callback?: Callback<T>): void;

Required permissions: ohos.permission.READ_ACCESSIBILITY_CONFIG

Cancels the listener for attribute changes. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BarrierFree.Accessibility.Core

Parameters

Error codes

For details about the error codes, see Accessibility Error Codes.

Example

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

config.highContrastText.off((data: boolean) => {
  console.info(`Unsubscribe highContrastText success, result: ${JSON.stringify(data)}`);
});

DaltonizationColorFilter

Enumerates the daltonization filters. DaltonizationColorFilter takes effect only when the daltonization filter is enabled (daltonizationState set to true).

System capability: SystemCapability.BarrierFree.Accessibility.Core

ClickResponseTime¹¹⁺

Defines the length of time for a click.

System capability: SystemCapability.BarrierFree.Accessibility.Core

RepeatClickInterval¹¹⁺

Defines the interval between repeated clicks. RepeatClickInterval takes effect only when repeated clicks are ignored (ignoreRepeatClick set to true).

System capability: SystemCapability.BarrierFree.Accessibility.Core

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Accessibility Kit

harmony 鸿蒙Accessibility Error Codes

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

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

harmony 鸿蒙@ohos.accessibility (Accessibility)

harmony 鸿蒙@ohos.application.AccessibilityExtensionAbility (AccessibilityExtensionAbility)

harmony 鸿蒙AccessibilityExtensionContext (System API)

harmony 鸿蒙AccessibilityExtensionContext (Accessibility Extension Context)