@ohos.accessibility.config (系统辅助功能配置)(系统接口)

本模块提供系统辅助功能的配置，包括辅助扩展的启用与关闭、高对比度文字显示、鼠标键、无障碍字幕配置等。

说明：

• 本模块首批接口从 API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
• 本模块接口为系统接口。

导入模块

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

属性

系统能力：以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Core

boolean返回值的含义：True表示开启，False表示关闭。 []()

enableAbility

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

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

启用辅助扩展，使用Promise异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

启用辅助扩展，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

关闭辅助扩展，使用Promise异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

关闭辅助扩展，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

添加启用的辅助扩展的列表变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

取消启用的辅助扩展的列表变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

添加已安装的辅助扩展的列表变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

取消已安装的辅助扩展的列表变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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

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

Config

用于属性的设置、获取与监听。

set

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

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

设置属性，使用Promise异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.WRITE_ACCESSIBILITY_CONFIG

设置属性，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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

获取属性，使用Promise异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

返回值：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

获取属性，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

添加属性变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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;

需要权限：ohos.permission.READ_ACCESSIBILITY_CONFIG

取消属性变化监听，使用callback异步回调。

系统能力：SystemCapability.BarrierFree.Accessibility.Core

参数：

错误码：

以下错误码的详细介绍请参见无障碍子系统错误码。

示例：

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

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

DaltonizationColorFilter

用于不同弱视类型的校正颜色滤镜。
颜色滤镜功能开启时（daltonizationState设置为true)，颜色滤镜的配置(即设置的DaltonizationColorFilter的值)生效；颜色滤镜功能关闭时（daltonizationState设置为false)，显示为正常类型¹¹⁺。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

ClickResponseTime¹¹⁺

用于不同时间长短的点击重复时间。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

RepeatClickInterval¹¹⁺

用于不同时间间隔的忽略重复点击。
忽略重复点击功能开启时（ignoreRepeatClick设置为true)，忽略重复点击的配置(即设置的RepeatClickInterval的值)生效；忽略重复点击功能关闭时（ignoreRepeatClick设置为false)，显示为正常类型。

系统能力：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core

你可能感兴趣的鸿蒙文章

harmony 鸿蒙Accessibility Kit（无障碍开发服务）

harmony 鸿蒙无障碍子系统错误码

harmony 鸿蒙@ohos.accessibility.GesturePath (手势路径)

harmony 鸿蒙@ohos.accessibility.GesturePoint (手势触摸点)

harmony 鸿蒙@ohos.accessibility (辅助功能)

harmony 鸿蒙@ohos.application.AccessibilityExtensionAbility (辅助功能扩展能力)

harmony 鸿蒙AccessibilityExtensionContext (辅助功能扩展上下文)(系统接口)

harmony 鸿蒙AccessibilityExtensionContext (辅助功能扩展上下文)