1# @ohos.accessibility.config (系统辅助功能配置)(系统接口) 2 3<!--Kit: Accessibility Kit--> 4<!--Subsystem: BarrierFree--> 5<!--Owner: @qiiiiiiian--> 6<!--Designer: @z7o--> 7<!--Tester: @A_qqq--> 8<!--Adviser: @w_Machine_cc--> 9 10本模块提供系统辅助功能的配置，包括辅助扩展的启用与关闭、高对比度文字显示、鼠标键、无障碍字幕配置等。 11 12> **说明：** 13> 14> - 本模块首批接口从 API version 9 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 15> - 本模块接口为系统接口。 16 17## 导入模块 18 19```ts 20import { config } from '@kit.AccessibilityKit'; 21``` 22 23## 属性 24 25**系统能力**：以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Core 26 27| 名称 | 类型 | 只读 | 可选 | 说明 | 28|------------------------------------|--------------------------------------------------------------------------------------------| -------- | -------- |-----------------------------------------------------------| 29| highContrastText | [Config](#config)\<boolean> | 否 | 否 | 表示高对比度文字功能启用状态。true表示已启用高对比度文字功能，false表示未启用高对比度文字功能，默认值为false。 | 30| invertColor | [Config](#config)\<boolean> | 否 | 否 | 表示颜色反转功能启用状态。true表示已启用颜色反转功能，false表示未启用颜色反转功能，默认值为false。 | 31| daltonizationState<sup>11+</sup> | [Config](#config)\<boolean> | 否 | 否 | 表示颜色滤镜功能启动状态。配合daltonizationColorFilter使用。true表示已启用颜色滤镜功能，false表示未启用颜色滤镜功能，默认值为false。 | 32| daltonizationColorFilter | [Config](#config)<[DaltonizationColorFilter](#daltonizationcolorfilter)> | 否 | 否 | 表示颜色滤镜功能配置。 | 33| contentTimeout | [Config](#config)\<number> | 否 | 否 | 表示内容显示建议时长配置。取值范围为0~5000，单位为毫秒。默认值为0。 | 34| animationOff | [Config](#config)\<boolean> | 否 | 否 | 表示关闭动画功能启用状态。true表示已启用关闭动画功能，false表示未启用关闭动画功能，默认值为false。 | 35| brightnessDiscount | [Config](#config)\<number> | 否 | 否 | 表示亮度折扣系统配置。取值范围为0~1.0。默认值为0.0。 | 36| mouseKey | [Config](#config)\<boolean> | 否 | 否 | 表示鼠标键功能启用状态。true表示已启用鼠标键功能，false表示未启用鼠标键功能，默认值为false。 | 37| mouseAutoClick | [Config](#config)\<number> | 否 | 否 | 表示鼠标自动点击操作的配置。取值范围0-5000，单位为毫秒，0表示不生效，其他值表示鼠标悬停相应的时长即触发自动点击操作，默认值为0，即默认不生效。 | 38| shortkey | [Config](#config)\<boolean> | 否 | 否 | 表示辅助扩展快捷键功能启用状态。true表示已启用辅助扩展快捷键功能，false表示未启用辅助扩展快捷键功能，默认值为false。 | 39| shortkeyTarget | [Config](#config)\<string> | 否 | 否 | 表示辅助扩展快捷键的目标配置。取值为辅助应用的名称，格式为：'bundleName/abilityName'。 | 40| captions | [Config](#config)\<boolean> | 否 | 否 | 表示辅助字幕功能启用状态。true表示已启用辅助字幕功能，false表示未启用辅助字幕功能，默认值为false。 | 41| captionsStyle | [Config](#config)\<[accessibility.CaptionsStyle](js-apis-accessibility.md#captionsstyle8)> | 否 | 否 | 表示辅助字幕的配置。 | 42| audioMono<sup>10+</sup> | [Config](#config)\<boolean> | 否 | 否 | 表示单声道音频的配置。true表示已启用单声道音频，false表示未启用单声道音频，默认值为false。 | 43| audioBalance<sup>10+</sup> | [Config](#config)\<number> | 否 | 否 | 表示左右声道音量平衡的配置。取值范围为-1.0~1.0。默认值为0.0。 | 44| shortkeyMultiTargets<sup>11+</sup> | [Config](#config)<Array\<string>> | 否 | 否 | 表示辅助扩展快捷键的列表配置。取值为辅助应用的名称，格式为：['bundleName/abilityName']。 | 45| clickResponseTime<sup>11+</sup> | [Config](#config)<[ClickResponseTime](#clickresponsetime11)> | 否 | 否 | 表示点击持续时间功能配置。 | 46| ignoreRepeatClick<sup>11+</sup> | [Config](#config)\<boolean> | 否 | 否 | 表示忽略重复点击功能启用状态。配合repeatClickInterval使用。true表示已启用忽略重复点击功能，false表示未启用忽略重复点击功能，默认值为false。 | 47| repeatClickInterval<sup>11+</sup> | [Config](#config)<[RepeatClickInterval](#repeatclickinterval11)> | 否 | 否 | 表示忽略重复点击功能配置。 | 48 49boolean返回值的含义：True表示开启，False表示关闭。 50[]() 51## enableAbility 52 53enableAbility(name: string, capability: Array<accessibility.Capability>): Promise<void> 54 55启用辅助扩展，使用Promise异步回调。 56 57**系统接口**：此接口为系统接口。 58 59**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 60 61**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 62 63**参数：** 64 65| 参数名 | 类型 | 必填 | 说明 | 66| -------- |------------------------------------------------------------------------------| -------- | -------- | 67| name | string | 是 | 辅助应用的名称，格式为：'bundleName/abilityName'。 | 68| capability | Array<[accessibility.Capability](js-apis-accessibility.md#capability)> | 是 | 辅助应用的能力属性。 | 69 70**返回值：** 71 72| 类型 | 说明 | 73| -------- | -------- | 74| Promise<void> | 无返回结果的Promise对象。 | 75 76**错误码：** 77 78以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[无障碍子系统错误码](errorcode-accessibility.md)。 79 80| 错误码ID | 错误信息 | 81| ------- | -------------------------------- | 82| 201 | Permission verification failed. The application does not have the permission required to call the API. | 83| 202 | Permission verification failed. A non-system application calls a system API. | 84| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 85| 9300001 | Invalid bundle name or ability name. | 86| 9300002 | Target ability already enabled. | 87 88**示例：** 89 90```ts 91import { accessibility, config } from '@kit.AccessibilityKit'; 92import { BusinessError } from '@kit.BasicServicesKit'; 93 94let name: string = 'com.ohos.example/axExtension'; 95let capability: accessibility.Capability[] = ['retrieve']; 96 97config.enableAbility(name, capability).then(() => { 98 console.info(`Succeeded in enable ability, name is ${name}, capability is ${capability}`); 99}).catch((err: BusinessError) => { 100 console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`); 101}); 102``` 103 104## enableAbility 105 106enableAbility(name: string, capability: Array<[accessibility.Capability](js-apis-accessibility.md#capability)>, callback: AsyncCallback<void>): void 107 108启用辅助扩展，使用callback异步回调。 109 110**系统接口**：此接口为系统接口。 111 112**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 113 114**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 115 116**参数：** 117 118| 参数名 | 类型 | 必填 | 说明 | 119| -------- |---------------------------------------------------------------------------------| -------- | -------- | 120| name | string | 是 | 辅助应用的名称，格式为：'bundleName/abilityName'。 | 121| capability | Array<[accessibility.Capability](js-apis-accessibility.md#capability)> | 是 | 辅助应用的能力属性。 | 122| callback | AsyncCallback<void> | 是 | 回调函数。 | 123 124**错误码：** 125 126以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[无障碍子系统错误码](errorcode-accessibility.md)。 127 128| 错误码ID | 错误信息 | 129| ------- | -------------------------------- | 130| 201 | Permission verification failed. The application does not have the permission required to call the API. | 131| 202 | Permission verification failed. A non-system application calls a system API. | 132| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 133| 9300001 | Invalid bundle name or ability name. | 134| 9300002 | Target ability already enabled. | 135 136**示例：** 137 138```ts 139import { accessibility, config } from '@kit.AccessibilityKit'; 140import { BusinessError } from '@kit.BasicServicesKit'; 141 142let name: string = 'com.ohos.example/axExtension'; 143let capability: accessibility.Capability[] = ['retrieve']; 144 145config.enableAbility(name, capability, (err: BusinessError) => { 146 if (err) { 147 console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`); 148 return; 149 } 150 console.info(`Succeeded in enable ability, name is ${name}, capability is ${capability}`); 151}); 152``` 153 154## disableAbility 155 156disableAbility(name: string): Promise<void> 157 158关闭辅助扩展，使用Promise异步回调。 159 160**系统接口**：此接口为系统接口。 161 162**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 163 164**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 165 166**参数：** 167 168| 参数名 | 类型 | 必填 | 说明 | 169| -------- | -------- | -------- | -------- | 170| name | string | 是 | 辅助应用的名称，格式为：'bundleName/abilityName'。 | 171 172**返回值：** 173 174| 类型 | 说明 | 175| -------- | -------- | 176| Promise<void> | 无返回结果的Promise对象。 | 177 178**错误码：** 179 180以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[无障碍子系统错误码](errorcode-accessibility.md)。 181 182| 错误码ID | 错误信息 | 183| ------- | -------------------------------- | 184| 201 | Permission verification failed. The application does not have the permission required to call the API. | 185| 202 | Permission verification failed. A non-system application calls a system API. | 186| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 187| 9300001 | Invalid bundle name or ability name. | 188 189**示例：** 190 191```ts 192import { accessibility, config } from '@kit.AccessibilityKit'; 193import { BusinessError } from '@kit.BasicServicesKit'; 194 195let name: string = 'com.ohos.example/axExtension'; 196 197config.disableAbility(name).then(() => { 198 console.info(`Succeeded in disable ability, name is ${name}`); 199}).catch((err: BusinessError) => { 200 console.error(`failed to disable ability, Code is ${err.code}, message is ${err.message}`); 201}) 202``` 203 204## disableAbility 205 206disableAbility(name: string, callback: AsyncCallback<void>): void 207 208关闭辅助扩展，使用callback异步回调。 209 210**系统接口**：此接口为系统接口。 211 212**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 213 214**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 215 216**参数：** 217 218| 参数名 | 类型 | 必填 | 说明 | 219| -------- | -------- | -------- | -------- | 220| name | string | 是 | 辅助应用的名称，格式为：'bundleName/abilityName'。 | 221| callback | AsyncCallback<void> | 是 | 回调函数。 | 222 223**错误码：** 224 225以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[无障碍子系统错误码](errorcode-accessibility.md)。 226 227| 错误码ID | 错误信息 | 228| ------- | -------------------------------- | 229| 201 | Permission verification failed. The application does not have the permission required to call the API. | 230| 202 | Permission verification failed. A non-system application calls a system API. | 231| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 232| 9300001 | Invalid bundle name or ability name. | 233 234**示例：** 235 236```ts 237import { accessibility, config } from '@kit.AccessibilityKit'; 238import { BusinessError } from '@kit.BasicServicesKit'; 239 240let name: string = 'com.ohos.example/axExtension'; 241 242config.disableAbility(name, (err: BusinessError) => { 243 if (err) { 244 console.error(`failed to enable ability, Code is ${err.code}, message is ${err.message}`); 245 return; 246 } 247 console.info(`Succeeded in disable, name is ${name}`); 248}); 249``` 250 251## on('enabledAccessibilityExtensionListChange') 252 253on(type: 'enabledAccessibilityExtensionListChange', callback: Callback<void>): void 254 255添加启用的辅助扩展的列表变化监听，使用callback异步回调。 256 257**系统接口**：此接口为系统接口。 258 259**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 260 261**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 262 263**参数：** 264 265| 参数名 | 类型 | 必填 | 说明 | 266| -------- | -------- | -------- | -------- | 267| type | string | 是 | 参数固定为'enabledAccessibilityExtensionListChange'，监听启用的辅助扩展的列表变化。 | 268| callback | Callback<void> | 是 | 回调函数，在启用的辅助扩展的列表变化时通过此函数进行通知。 | 269 270**错误码：** 271 272以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 273 274| 错误码ID | 错误信息 | 275| ------- | -------------------------------- | 276| 201 | Permission verification failed. The application does not have the permission required to call the API. | 277| 202 | Permission verification failed. A non-system application calls a system API. | 278| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 279 280**示例：** 281 282```ts 283import { config } from '@kit.AccessibilityKit'; 284 285config.on('enabledAccessibilityExtensionListChange', () => { 286 console.info('subscribe enabled accessibility extension list change state success'); 287}); 288``` 289 290## off('enabledAccessibilityExtensionListChange') 291 292off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback<void>): void 293 294取消启用的辅助扩展的列表变化监听，使用callback异步回调。 295 296**系统接口**：此接口为系统接口。 297 298**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 299 300**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 301 302**参数：** 303 304| 参数名 | 类型 | 必填 | 说明 | 305| -------- | -------- | -------- | -------- | 306| type | string | 是 | 参数固定为'enabledAccessibilityExtensionListChange'，监听启用的辅助扩展的列表变化。 | 307| callback | Callback<void> | 否 | 取消指定callback对象的事件响应。需与on('enabledAccessibilityExtensionListChange')的callback一致。缺省时，表示注销所有已注册事件。 | 308 309**错误码：** 310 311以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 312 313| 错误码ID | 错误信息 | 314| ------- | -------------------------------- | 315| 201 | Permission verification failed. The application does not have the permission required to call the API. | 316| 202 | Permission verification failed. A non-system application calls a system API. | 317| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 318 319**示例：** 320 321```ts 322import { config } from '@kit.AccessibilityKit'; 323 324config.off('enabledAccessibilityExtensionListChange', () => { 325 console.info('Unsubscribe enabled accessibility extension list change state success'); 326}); 327``` 328 329## on('installedAccessibilityListChange')<sup>12+</sup> 330 331on(type: 'installedAccessibilityListChange', callback: Callback<void>): void 332 333添加已安装的辅助扩展的列表变化监听，使用callback异步回调。 334 335**系统接口**：此接口为系统接口。 336 337**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 338 339**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 340 341**参数：** 342 343| 参数名 | 类型 | 必填 | 说明 | 344| -------- | -------- | -------- | -------- | 345| type | string | 是 | 参数固定为'installedAccessibilityListChange'，监听已安装的辅助扩展的列表变化。 | 346| callback | Callback<void> | 是 | 回调函数，在已安装的辅助扩展的列表变化时通过此函数进行通知。 | 347 348**错误码：** 349 350以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 351 352| 错误码ID | 错误信息 | 353| ------- | -------------------------------- | 354| 201 | Permission verification failed. The application does not have the permission required to call the API. | 355| 202 | Permission verification failed. A non-system application calls a system API. | 356| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 357 358**示例：** 359 360```ts 361import { config } from '@kit.AccessibilityKit'; 362 363config.on('installedAccessibilityListChange', () => { 364 console.info('subscribe installed accessibility extension list change state success'); 365}); 366``` 367 368## off('installedAccessibilityListChange')<sup>12+</sup> 369 370off(type: 'installedAccessibilityListChange', callback?: Callback<void>): void 371 372取消已安装的辅助扩展的列表变化监听，使用callback异步回调。 373 374**系统接口**：此接口为系统接口。 375 376**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 377 378**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 379 380**参数：** 381 382| 参数名 | 类型 | 必填 | 说明 | 383| -------- | -------- | -------- | -------- | 384| type | string | 是 | 参数固定为'installedAccessibilityListChange'，监听已安装的辅助扩展的列表变化。 | 385| callback | Callback<void> | 否 | 取消指定callback对象的事件响应。需与on('installedAccessibilityListChange')的callback一致。缺省时，表示注销所有已注册事件。 | 386 387**错误码：** 388 389以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 390 391| 错误码ID | 错误信息 | 392| ------- | -------------------------------- | 393| 201 | Permission verification failed. The application does not have the permission required to call the API. | 394| 202 | Permission verification failed. A non-system application calls a system API. | 395| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 396 397**示例：** 398 399```ts 400import { config } from '@kit.AccessibilityKit'; 401 402config.off('installedAccessibilityListChange', () => { 403 console.info('Unsubscribe installed accessibility extension list change state success'); 404}); 405``` 406## setMagnificationState<sup>20+</sup> 407 408setMagnificationState(state: boolean): void 409 410触发或者关闭放大手势功能的放大效果，使用前需要保证放大手势功能已开启。 411 412**系统接口**：此接口为系统接口。 413 414**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 415 416**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 417 418**参数：** 419 420| 参数名 | 类型 | 必填 | 说明 | 421| -------- | -------- | -------- | -------- | 422| state | boolean | 是 | 表示放大手势功能的放大效果的启用状态。<br>-true：表示触发放大效果。<br>-false：表示关闭放大效果。 | 423 424**错误码：** 425 426以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)和[无障碍子系统错误码](errorcode-accessibility.md)。 427 428| 错误码ID | 错误信息 | 429| ------- | -------------------------------- | 430| 201 | Permission verification failed. The application does not have the permission required to call the API. | 431| 202 | Permission verification failed. A non-system application calls a system API. | 432| 801 | Capability not supported. Failed to call the API due to limited device capabilities. | 433| 9300007 | Trigger magnification failed. | 434 435**示例：** 436 437```ts 438import { config } from '@kit.AccessibilityKit'; 439 440try { 441 config.setMagnificationState(true); 442} catch (e) { 443 console.error(`Set magnification failed, error code: ${e?.code}, error msg: ${e?.message}`); 444} 445``` 446 447## Config 448 449用于属性的设置、获取与监听。 450 451### set 452 453set(value: T): Promise<void> 454 455设置属性，使用Promise异步回调。 456 457**系统接口**：此接口为系统接口。 458 459**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 460 461**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 462 463**参数：** 464 465| 参数名 | 类型 | 必填 | 说明 | 466| -------- | -------- | -------- | -------- | 467| value | T | 是 | 设置的属性值。 | 468 469**返回值：** 470 471| 类型 | 说明 | 472| -------- | -------- | 473| Promise<void> | 无返回结果的Promise对象。 | 474 475**错误码：** 476 477以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 478 479| 错误码ID | 错误信息 | 480| ------- | -------------------------------- | 481| 201 | Permission verification failed. The application does not have the permission required to call the API. | 482| 202 | Permission verification failed. A non-system application calls a system API. | 483| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 484 485**示例：** 486 487```ts 488import { config } from '@kit.AccessibilityKit'; 489import { BusinessError } from '@kit.BasicServicesKit'; 490 491let value: boolean = true; 492 493config.highContrastText.set(value).then(() => { 494 console.info(`Succeeded in set highContrastText value is ${value}`); 495}).catch((err: BusinessError) => { 496 console.error(`failed to set highContrastText, Code is ${err.code}, message is ${err.message}`); 497}); 498``` 499 500### set 501 502set(value: T, callback: AsyncCallback<void>): void 503 504设置属性，使用callback异步回调。 505 506**系统接口**：此接口为系统接口。 507 508**需要权限**：ohos.permission.WRITE_ACCESSIBILITY_CONFIG 509 510**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 511 512**参数：** 513 514| 参数名 | 类型 | 必填 | 说明 | 515| -------- | -------- | -------- | -------- | 516| value | T | 是 | 设置的属性值。 | 517| callback | AsyncCallback<void> | 是 | 回调函数。 | 518 519**错误码：** 520 521以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 522 523| 错误码ID | 错误信息 | 524| ------- | -------------------------------- | 525| 201 | Permission verification failed. The application does not have the permission required to call the API. | 526| 202 | Permission verification failed. A non-system application calls a system API. | 527| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 528 529**示例：** 530 531```ts 532import { config } from '@kit.AccessibilityKit'; 533import { BusinessError } from '@kit.BasicServicesKit'; 534 535let value: boolean = true; 536 537config.highContrastText.set(value, (err: BusinessError) => { 538 if (err) { 539 console.error(`failed to set highContrastText, Code is ${err.code}, message is ${err.message}`); 540 return; 541 } 542 console.info(`Succeeded in set highContrastText, value is ${value}`); 543}); 544``` 545 546### get 547 548get(): Promise<T> 549 550获取属性，使用Promise异步回调。 551 552**系统接口**：此接口为系统接口。 553 554**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 555 556**返回值：** 557 558| 类型 | 说明 | 559| -------- | -------- | 560| Promise<T> | Promise对象，返回对应属性值。 | 561 562**错误码：** 563 564以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 565 566| 错误码ID | 错误信息 | 567| ------- | -------------------------------- | 568| 201 | Permission verification failed. The application does not have the permission required to call the API. | 569| 202 | Permission verification failed. A non-system application calls a system API. | 570 571**示例：** 572 573```ts 574import { config } from '@kit.AccessibilityKit'; 575import { BusinessError } from '@kit.BasicServicesKit'; 576 577config.highContrastText.get().then((data: boolean) => { 578 console.info(`Succeeded in get highContrastText, data is ${data}`); 579}).catch((err: BusinessError) => { 580 console.error(`failed to get highContrastText, Code is ${err.code}, message is ${err.message}`); 581}); 582``` 583 584### get 585 586get(callback: AsyncCallback<T>): void 587 588获取属性，使用callback异步回调。 589 590**系统接口**：此接口为系统接口。 591 592**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 593 594**参数：** 595 596| 参数名 | 类型 | 必填 | 说明 | 597| -------- | -------- | -------- | -------- | 598| callback | AsyncCallback<T> | 是 | 回调函数，返回属性值。 | 599 600**错误码：** 601 602以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 603 604| 错误码ID | 错误信息 | 605| ------- | -------------------------------- | 606| 202 | Permission verification failed. A non-system application calls a system API. | 607 608**示例：** 609 610```ts 611import { config } from '@kit.AccessibilityKit'; 612import { BusinessError } from '@kit.BasicServicesKit'; 613 614config.highContrastText.get((err: BusinessError, data: boolean) => { 615 if (err) { 616 console.error(`failed to get highContrastText, Code is ${err.code}, message is ${err.message}`); 617 return; 618 } 619 console.info(`Succeeded in get highContrastText, data is ${data}`); 620}); 621``` 622 623### on 624 625on(callback: Callback<T>): void 626 627添加属性变化监听，使用callback异步回调。 628 629**系统接口**：此接口为系统接口。 630 631**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 632 633**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 634 635**参数：** 636 637| 参数名 | 类型 | 必填 | 说明 | 638| -------- | -------- | -------- | -------- | 639| callback | Callback<T> | 是 | 回调函数，在属性变化时通过此函数进行通知。 | 640 641**错误码：** 642 643以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 644 645| 错误码ID | 错误信息 | 646| ------- | -------------------------------- | 647| 201 | Permission verification failed. The application does not have the permission required to call the API. | 648| 202 | Permission verification failed. A non-system application calls a system API. | 649| 401 | Parameter error. Possible causes: 1. Mandatory parameters are left unspecified; 2. Incorrect parameter types; 3. Parameter verification failed. | 650 651**示例：** 652 653```ts 654import { config } from '@kit.AccessibilityKit'; 655 656config.highContrastText.on((data: boolean) => { 657 console.info(`subscribe highContrastText success, result: ${JSON.stringify(data)}`); 658}); 659``` 660 661### off 662 663off(callback?: Callback<T>): void 664 665取消属性变化监听，使用callback异步回调。 666 667**系统接口**：此接口为系统接口。 668 669**需要权限**：ohos.permission.READ_ACCESSIBILITY_CONFIG 670 671**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 672 673**参数：** 674 675| 参数名 | 类型 | 必填 | 说明 | 676| -------- | -------- | -------- | -------- | 677| callback | Callback<T> | 否 | 取消指定callback对象的事件响应。需与on()的callback一致。缺省时，表示注销所有已注册事件。 | 678 679**错误码：** 680 681以下错误码的详细介绍请参见[通用错误码](../errorcode-universal.md)。 682 683| 错误码ID | 错误信息 | 684| ------- | -------------------------------- | 685| 201 | Permission verification failed. The application does not have the permission required to call the API. | 686| 202 | Permission verification failed. A non-system application calls a system API. | 687 688**示例：** 689 690```ts 691import { config } from '@kit.AccessibilityKit'; 692 693config.highContrastText.off((data: boolean) => { 694 console.info(`Unsubscribe highContrastText success, result: ${JSON.stringify(data)}`); 695}); 696``` 697 698## DaltonizationColorFilter 699 700用于不同弱视类型的校正颜色滤镜。 701颜色滤镜功能开启时（[daltonizationState](#属性)设置为true)，颜色滤镜的配置(即设置的DaltonizationColorFilter的值)生效；颜色滤镜功能关闭时（[daltonizationState](#属性)设置为false)，显示为正常类型<sup>11+</sup>。 702 703**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 704 705| 名称 | 说明 | 706| -------- | -------- | 707| Normal | 表示正常类型。 | 708| Protanomaly | 表示红色弱视类型。 | 709| Deuteranomaly | 表示绿色弱视类型。 | 710| Tritanomaly | 表示蓝色弱视类型。 | 711 712## ClickResponseTime<sup>11+</sup> 713 714用于不同时间长短的点击重复时间。 715 716**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 717 718| 名称 | 说明 | 719|-------------|------------| 720| Short | 表示短 (默认)。 | 721| Medium | 表示中。 | 722| Long | 表示长。 | 723 724## RepeatClickInterval<sup>11+</sup> 725 726用于不同时间间隔的忽略重复点击。 727忽略重复点击功能开启时（[ignoreRepeatClick](#属性)设置为true)，忽略重复点击的配置(即设置的RepeatClickInterval的值)生效；忽略重复点击功能关闭时（[ignoreRepeatClick](#属性)设置为false)，显示为正常类型。 728 729**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 730 731| 名称 | 说明 | 732|----------|-------| 733| Shortest | 表示最短。 | 734| Short | 表示短。 | 735| Medium | 表示中。 | 736| Long | 表示长。 | 737| Longest | 表示最长。 | 738 739