1# @ohos.accessibility (辅助功能) 2 3本模块提供辅助功能查询能力，包括获取辅助应用列表、辅助应用启用状态、无障碍字幕配置等。 4 5> **说明：** 6> 7> - 本模块首批接口从 API version 7 开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 8 9## 导入模块 10 11```ts 12import accessibility from '@ohos.accessibility'; 13``` 14 15## AbilityState 16 17辅助应用状态类型。 18 19**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 20 21| 名称 | 描述 | 22| ------- | -------- | 23| enable | 辅助应用已启用。 | 24| disable | 辅助应用已禁用。 | 25| install | 辅助应用已安装。 | 26 27## AbilityType 28 29无障碍辅助应用类型。 30 31**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 32 33| 名称 | 描述 | 34| ---------------- | --------- | 35| audible | 表示具有听觉反馈。 | 36| generic | 表示具有通用反馈。 | 37| haptic | 表示具有触觉反馈。 | 38| spoken | 表示具有语音反馈。 | 39| visual | 表示具有视觉反馈。 | 40| all<sup>9+</sup> | 表示以上所有类别。 | 41 42## AccessibilityAbilityInfo 43 44辅助应用信息。 45 46**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 47 48### 属性 49 50| 名称 | 类型 | 可读 | 可写 | 说明 | 51| ------------------------------ | ---------------------------------------- | ---- | ---- | ---------------- | 52| id | string | 是 | 否 | ability id。 | 53| name | string | 是 | 否 | ability 名。 | 54| bundleName | string | 是 | 否 | Bundle名称。 | 55| targetBundleNames<sup>9+</sup> | Array<string> | 是 | 否 | 关注的目标Bundle名称。 | 56| abilityTypes | Array<[AbilityType](#abilitytype)> | 是 | 否 | 辅助应用类型。 | 57| capabilities | Array<[Capability](#capability)> | 是 | 否 | 辅助应用能力列表。 | 58| description | string | 是 | 否 | 辅助应用描述。 | 59| eventTypes | Array<[EventType](#eventtype)> | 是 | 否 | 辅助应用关注的无障碍事件列表。 | 60 61## Action 62 63应用所支持的目标动作。 64 65**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 66 67| 名称 | 描述 | 68| ----------------------- |--------------------| 69| click | 表示点击操作。 | 70| longClick | 表示长按操作。 | 71| scrollForward | 表示向前滚动操作。 | 72| scrollBackward | 表示向后滚动操作。 | 73| focus | 表示获得焦点操作。 | 74| clearFocus | 表示清除焦点操作。 | 75| clearSelection | 表示清除选择操作。当前版本暂不支持。 | 76| accessibilityFocus | 表示获得无障碍焦点操作。 | 77| clearAccessibilityFocus | 表示清除无障碍焦点操作。 | 78| cut | 表示剪切操作。 | 79| copy | 表示复制操作。 | 80| paste | 表示粘贴操作。 | 81| select | 表示选择操作。当前版本暂不支持。 | 82| setText | 表示设置文本操作。当前版本暂不支持。 | 83| delete | 表示删除操作。当前版本暂不支持。 | 84| setSelection | 表示选择操作。 | 85 86## Capability 87 88辅助应用能力类型。 89 90**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 91 92| 名称 | 描述 | 93| ---------------- |-----------------------| 94| retrieve | 具有检索窗口内容的能力。 | 95| touchGuide | 具有触摸探索模式的能力。 | 96| keyEventObserver | 具有过滤按键事件的能力。 | 97| zoom | 具有控制显示放大的能力。当前版本暂不支持。 | 98| gesture | 具有执行手势动作的能力。 | 99 100## CaptionsFontEdgeType<sup>8+</sup> 101 102字幕字体边缘类型。 103 104**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing 105 106| 名称 | 描述 | 107| ---------- | ----- | 108| none | 无效果。 | 109| raised | 凸起效果。 | 110| depressed | 凹陷效果。 | 111| uniform | 轮廓效果。 | 112| dropShadow | 阴影效果。 | 113 114## CaptionsFontFamily<sup>8+</sup> 115 116字幕字体。 117 118**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing 119 120| 名称 | 描述 | 121| ------------------- | ----------------- | 122| default | 默认字体。 | 123| monospacedSerif | 等宽 Serif 字体。 | 124| serif | Serif 字体。 | 125| monospacedSansSerif | 等宽 Sans Serif 字体。 | 126| sansSerif | Sans Serif 字体。 | 127| casual | 非正式字体。 | 128| cursive | 手写字体。 | 129| smallCapitals | 小型大写字母字体。 | 130 131## CaptionsStyle<sup>8+</sup> 132 133字幕风格。 134 135**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Hearing 136 137| 名称 | 类型 | 可读 | 可写 | 说明 | 138| --------------- | ---------------------------------------- | ---- | ---- | ----------- | 139| fontFamily | [CaptionsFontFamily](#captionsfontfamily8) | 是 | 否 | 描述字幕字体。 | 140| fontScale | number | 是 | 否 | 描述字幕字体缩放系数，单位%，参数范围1~200。 | 141| fontColor | number \| string | 是 | 否 | 描述字幕字体颜色，例如red对应#FF0000。 | 142| fontEdgeType | [CaptionsFontEdgeType](#captionsfontedgetype8) | 是 | 否 | 描述字幕字体边缘。 | 143| backgroundColor | number \| string | 是 | 否 | 描述字幕背景颜色，例如red对应#FF0000。 | 144| windowColor | number \| string | 是 | 否 | 描述字幕窗口颜色，例如red对应#FF0000。 | 145 146## CaptionsManager<sup>8+</sup> 147 148字幕配置管理，在调用CaptionsManager的方法前，需要先通过 [accessibility.getCaptionsManager() ](#accessibilitygetcaptionsmanager8)获取 CaptionsManager实例。 149 150**系统能力**：以下各项对应的系统能力均为SystemCapability.BarrierFree.Accessibility.Hearing 151 152### 属性 153 154| 名称 | 类型 | 可读 | 可写 | 说明 | 155| ------- | -------------------------------- | ---- | ---- | ----------- | 156| enabled | boolean | 是 | 否 | 表示是否启用字幕配置。 | 157| style | [CaptionsStyle](#captionsstyle8) | 是 | 否 | 表示字幕风格。 | 158 159boolean返回值的含义：True表示开启，False表示关闭。 160 161### on('enableChange') 162 163on(type: 'enableChange', callback: Callback<boolean>): void; 164 165监听字幕配置启用状态变化事件，使用callback异步回调。 166 167**系统能力**：SystemCapability.BarrierFree.Accessibility.Hearing 168 169**参数：** 170 171| 参数名 | 类型 | 必填 | 说明 | 172| -------- | ----------------------- | ---- | --------------------------------------- | 173| type | string | 是 | 监听的事件名，固定为‘enableChange’，即字幕配置启用状态变化事件。 | 174| callback | Callback<boolean> | 是 | 回调函数，在启用状态变化时将状态通过此函数进行通知。 | 175 176**示例：** 177 178```ts 179import accessibility from '@ohos.accessibility'; 180 181let captionsManager = accessibility.getCaptionsManager(); 182captionsManager.on('enableChange', (data: boolean) => { 183 console.info(`subscribe caption manager enable state change, result: ${JSON.stringify(data)}`); 184}) 185``` 186 187### on('styleChange') 188 189on(type: 'styleChange', callback: Callback<CaptionsStyle>): void; 190 191监听字幕风格变化事件，使用callback异步回调。 192 193**系统能力**：SystemCapability.BarrierFree.Accessibility.Hearing 194 195**参数：** 196 197| 参数名 | 类型 | 必填 | 说明 | 198| -------- | ---------------------------------------- | ---- | ---------------------------------- | 199| type | string | 是 | 监听的事件名，固定为‘styleChange’，即字幕风格变化事件。 | 200| callback | Callback<[CaptionsStyle](#captionsstyle8)> | 是 | 回调函数，在字幕风格变化时通过此函数进行通知。 | 201 202**示例：** 203 204```ts 205import accessibility from '@ohos.accessibility'; 206 207let captionsManager = accessibility.getCaptionsManager(); 208 209captionsManager.on('styleChange', (data: accessibility.CaptionsStyle) => { 210 console.info(`subscribe caption manager style state change, result: ${JSON.stringify(data)}`); 211}); 212``` 213 214### off('enableChange') 215 216off(type: 'enableChange', callback?: Callback<boolean>): void; 217 218取消监听字幕配置启用状态变化事件，使用callback异步回调。 219 220**系统能力**：SystemCapability.BarrierFree.Accessibility.Hearing 221 222**参数：** 223 224| 参数名 | 类型 | 必填 | 说明 | 225| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 226| type | string | 是 | 取消监听的事件名，固定为‘enableChange’，即字幕配置启用状态变化事件。 | 227| callback | Callback<boolean> | 否 | 回调函数，取消指定callback对象的事件响应。需与on('enableChange')的callback一致。缺省时，表示注销所有已注册事件。 | 228 229**示例：** 230 231```ts 232import accessibility from '@ohos.accessibility'; 233 234let captionsManager = accessibility.getCaptionsManager(); 235 236captionsManager.off('enableChange', (data: boolean) => { 237 console.info(`Unsubscribe caption manager enable state change, result: ${JSON.stringify(data)}`); 238}); 239``` 240 241### off('styleChange') 242 243off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void; 244 245取消字幕风格变化监听事件，使用callback异步回调。 246 247**系统能力**：SystemCapability.BarrierFree.Accessibility.Hearing 248 249**参数：** 250 251| 参数名 | 类型 | 必填 | 说明 | 252| -------- | ------------------------------------------------ | ---- | ------------------------------------------------------------ | 253| type | string | 是 | 取消监听的事件名，固定为‘styleChange’，即字幕风格变化事件。 | 254| callback | Callback<[CaptionsStyle](#captionsstyle8)> | 否 | 回调函数，取消指定callback对象的事件响应。需与on('styleChange')的callback一致。缺省时，表示注销所有已注册事件。 | 255 256**示例：** 257 258```ts 259import accessibility from '@ohos.accessibility'; 260 261let captionsManager = accessibility.getCaptionsManager(); 262 263captionsManager.off('styleChange', (data: accessibility.CaptionsStyle) => { 264 console.info(`Unsubscribe caption manager style state change, result: ${JSON.stringify(data)}`); 265}); 266``` 267 268## EventInfo 269 270界面变更事件。 271 272**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 273 274### 属性 275 276| 名称 | 类型 | 必填 | 说明 | 277| ---------------- | ------------------------------------- |-----|-----------------------| 278| type | [EventType](#eventtype) | 是 | 无障碍事件类型；不可缺省。 | 279| windowUpdateType | [WindowUpdateType](#windowupdatetype) | 否 | 窗口变化类型。 | 280| bundleName | string | 是 | 目标应用名；不可缺省。 | 281| componentType | string | 否 | 事件源组件类型，如按钮、图表。 | 282| pageId | number | 否 | 事件源的页面 ID。 | 283| description | string | 否 | 事件描述。当前版本暂不支持。 | 284| triggerAction | [Action](#action) | 是 | 触发事件的 Action；不可缺省。 | 285| textMoveUnit | [TextMoveUnit](#textmoveunit) | 否 | 文本移动粒度。当前版本暂不支持。 | 286| contents | Array<string> | 否 | 内容列表。 | 287| lastContent | string | 否 | 最新内容。 | 288| beginIndex | number | 否 | 画面显示条目的开始序号。当前版本暂不支持。 | 289| currentIndex | number | 否 | 当前条目序号。当前版本暂不支持。 | 290| endIndex | number | 否 | 画面显示条目的结束序号。当前版本暂不支持。 | 291| itemCount | number | 否 | 条目总数。当前版本暂不支持。 | 292 293### constructor 294 295constructor(jsonObject) 296 297构造函数。 298 299**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 300 301**参数：** 302 303| 参数名 | 类型 | 必填 | 说明 | 304| ---------- | ------ | ---- | -------------------- | 305| jsonObject | string | 是 | 创建对象所需要的 JSON 格式字符串。 | 306 307**示例：** 308 309 ```ts 310 import accessibility from '@ohos.accessibility'; 311 312 let eventInfo: accessibility.EventInfo = ({ 313 type: 'click', 314 bundleName: 'com.example.MyApplication', 315 triggerAction: 'click', 316 }); 317 ``` 318 319### constructor<sup>11+</sup> 320 321constructor(type: EventType, bundleName: string, triggerAction: Action) 322 323构造函数。 324 325**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 326 327**参数：** 328 329| 参数名 | 类型 | 必填 | 说明 | 330|------|-------------------|---|---------------| 331| type | [EventType](#eventtype) | 是 | 无障碍事件类型。 | 332| bundleName | string | 是 | 目标应用名。 | 333| triggerAction | [Action](#action) | 是 | 触发事件的 Action。 | 334 335**示例：** 336 337 ```ts 338 import accessibility from '@ohos.accessibility'; 339 340 let eventInfo = new accessibility.EventInfo('click', 'com.example.MyApplication', 'click'); 341 ``` 342 343## EventType 344 345无障碍事件类型。 346 347**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 348 349| 名称 | 描述 | 350| ----------------------- |------------------------| 351| accessibilityFocus | 描述获得无障碍焦点的事件。 | 352| accessibilityFocusClear | 描述清除无障碍焦点的事件。 | 353| click | 描述点击组件的事件。 | 354| longClick | 描述长按组件的事件。 | 355| select | 描述选择组件的事件。 | 356| hoverEnter | 描述悬停进入组件的事件。当前版本暂不支持。 | 357| hoverExit | 描述悬停离开组件的事件。当前版本暂不支持。 | 358| focus | 描述组件获得焦点的事件。当前版本暂不支持。 | 359| textUpdate | 描述组件文本已更改的事件。 | 360| textSelectionUpdate | 描述选定文本已更改的事件。当前版本暂不支持。 | 361| scroll | 描述滚动视图的事件。 | 362 363 364## TextMoveUnit 365 366文本无障碍导航移动粒度。 367 368**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 369 370| 名称 | 描述 | 371| --------- | --------------- | 372| char | 以字符为移动粒度遍历节点文本。 | 373| word | 以词为移动粒度遍历节点文本。 | 374| line | 以行为移动粒度遍历节点文本。 | 375| page | 以页为移动粒度遍历节点文本。 | 376| paragraph | 以段落为移动粒度遍历节点文本。 | 377 378## WindowUpdateType 379 380窗口变化类型。 381 382**系统能力**：以下各项对应的系统能力均为 SystemCapability.BarrierFree.Accessibility.Core 383 384| 名称 | 描述 | 385| ------ | ------------------ | 386| add | 添加窗口的窗口变化事件。 | 387| remove | 一个窗口被删除的窗口变化事件。 | 388| bounds | 窗口边界已更改的窗口变化事件。 | 389| active | 窗口变为活动或不活动的窗口变化事件。 | 390| focus | 窗口焦点发生变化的窗口变化事件。 | 391 392## accessibility.getAbilityLists<sup>(deprecated)</sup> 393 394getAbilityLists(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>> 395 396查询辅助应用列表，使用Promise异步回调。 397 398> **说明：** 399> 400> 从API version 7开始支持，从API version 9开始废弃。 401> 推荐使用[accessibility.getAccessibilityExtensionList()](#accessibilitygetaccessibilityextensionlist9)。 402 403**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 404 405**参数：** 406 407| 参数名 | 类型 | 必填 | 说明 | 408| ----------- | ----------------------------- | ---- | -------- | 409| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 | 410| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 | 411 412**返回值：** 413 414| 类型 | 说明 | 415| ---------------------------------------- | --------------------- | 416| Promise<Array<[AccessibilityAbilityInfo](#accessibilityabilityinfo)>> | Promise对象，返回辅助应用信息列表。 | 417 418**示例：** 419 420```ts 421import accessibility from '@ohos.accessibility'; 422import { BusinessError } from '@ohos.base'; 423 424let abilityType: accessibility.AbilityType = 'spoken'; 425let abilityState: accessibility.AbilityState = 'enable'; 426 427accessibility.getAbilityLists(abilityType, abilityState).then((data: accessibility.AccessibilityAbilityInfo[]) => { 428 console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`); 429}).catch((err: BusinessError) => { 430 console.error(`failed to get accessibility extension list because ${JSON.stringify(err)}`); 431}); 432``` 433 434## accessibility.getAbilityLists<sup>(deprecated)</sup> 435 436getAbilityLists(abilityType: AbilityType, stateType: AbilityState,callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void 437 438查询辅助应用列表，使用callback异步回调。 439 440> **说明：** 441> 442> 从API version 7开始支持，从API version 9开始废弃。 443> 推荐使用[accessibility.getAccessibilityExtensionList()](#accessibilitygetaccessibilityextensionlist9-1)。 444 445**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 446 447**参数：** 448 449| 参数名 | 类型 | 必填 | 说明 | 450| ----------- | ---------------------------------------- | ---- | ---------------- | 451| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 | 452| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 | 453| callback | AsyncCallback<Array<[AccessibilityAbilityInfo](#accessibilityabilityinfo)>> | 是 | 回调函数，返回辅助应用信息列表。 | 454 455**示例：** 456 457```ts 458import accessibility from '@ohos.accessibility'; 459import { BusinessError } from '@ohos.base'; 460 461let abilityType: accessibility.AbilityType = 'spoken'; 462let abilityState: accessibility.AbilityState = 'enable'; 463 464accessibility.getAbilityLists(abilityType, abilityState, (err: BusinessError, data: accessibility.AccessibilityAbilityInfo[]) => { 465 if (err) { 466 console.error(`failed to get accessibility extension list because ${JSON.stringify(err)}`); 467 return; 468 } 469 console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`); 470}) 471``` 472 473## accessibility.getAccessibilityExtensionList<sup>9+</sup> 474 475getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState): Promise<Array<AccessibilityAbilityInfo>> 476 477查询辅助应用列表，使用Promise异步回调。 478 479**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 480 481**参数：** 482 483| 参数名 | 类型 | 必填 | 说明 | 484| ----------- | ----------------------------- | ---- | -------- | 485| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 | 486| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 | 487 488**返回值：** 489 490| 类型 | 说明 | 491| ---------------------------------------- | --------------------- | 492| Promise<Array<[AccessibilityAbilityInfo](#accessibilityabilityinfo)>> | Promise对象，返回辅助应用信息列表。 | 493 494**示例：** 495 496```ts 497import accessibility from '@ohos.accessibility'; 498import { BusinessError } from '@ohos.base'; 499 500let abilityType: accessibility.AbilityType = 'spoken'; 501let abilityState: accessibility.AbilityState = 'enable'; 502 503accessibility.getAccessibilityExtensionList(abilityType, abilityState).then((data: accessibility.AccessibilityAbilityInfo[]) => { 504 console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`); 505}).catch((err: BusinessError) => { 506 console.error(`failed to get accessibility extension list, Code is ${err.code}, message is ${err.message}`); 507}); 508``` 509 510## accessibility.getAccessibilityExtensionList<sup>9+</sup> 511 512getAccessibilityExtensionList(abilityType: AbilityType, stateType: AbilityState, callback: AsyncCallback<Array<AccessibilityAbilityInfo>>): void 513 514查询辅助应用列表，使用callback异步回调。 515 516**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 517 518**参数：** 519 520| 参数名 | 类型 | 必填 | 说明 | 521| ----------- | ---------------------------------------- | ---- | ---------------- | 522| abilityType | [AbilityType](#abilitytype) | 是 | 辅助应用的类型。 | 523| stateType | [AbilityState](#abilitystate) | 是 | 辅助应用的状态。 | 524| callback | AsyncCallback<Array<[AccessibilityAbilityInfo](#accessibilityabilityinfo)>> | 是 | 回调函数，返回辅助应用信息列表。 | 525 526**示例：** 527 528```ts 529import accessibility from '@ohos.accessibility'; 530import { BusinessError } from '@ohos.base'; 531 532let abilityType: accessibility.AbilityType = 'spoken'; 533let abilityState: accessibility.AbilityState = 'enable'; 534 535accessibility.getAccessibilityExtensionList(abilityType, abilityState,(err: BusinessError, data: accessibility.AccessibilityAbilityInfo[]) => { 536 if (err) { 537 console.error(`failed to get accessibility extension list, Code is ${err.code}, message is ${err.message}`); 538 return; 539 } 540 console.info(`Succeeded in get accessibility extension list, ${JSON.stringify(data)}`); 541}); 542``` 543 544## accessibility.getCaptionsManager<sup>8+</sup> 545 546getCaptionsManager(): CaptionsManager 547 548获取无障碍字幕配置管理实例。 549 550**系统能力**：SystemCapability.BarrierFree.Accessibility.Hearing 551 552**返回值：** 553 554| 类型 | 说明 | 555| ------------------------------------ | ---------- | 556| [CaptionsManager](#captionsmanager8) | 无障碍字幕配置管理。 | 557 558**示例：** 559 560```ts 561import accessibility from '@ohos.accessibility'; 562 563let captionsManager = accessibility.getCaptionsManager(); 564``` 565 566## accessibility.on('accessibilityStateChange') 567 568on(type: 'accessibilityStateChange', callback: Callback<boolean>): void 569 570监听辅助应用启用状态变化事件，使用callback异步回调。 571 572**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 573 574**参数：** 575 576| 参数名 | 类型 | 必填 | 说明 | 577| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 578| type | string | 是 | 监听的事件名，固定为‘accessibilityStateChange’，即辅助应用启用状态变化事件。 | 579| callback | Callback<boolean> | 是 | 回调函数，在辅助应用启用状态变化时将状态通过此函数进行通知。此状态为全局辅助应用启用状态。 | 580 581**示例：** 582 583```ts 584import accessibility from '@ohos.accessibility'; 585 586accessibility.on('accessibilityStateChange', (data: boolean) => { 587 console.info(`subscribe accessibility state change, result: ${JSON.stringify(data)}`); 588}); 589``` 590 591## accessibility.on('touchGuideStateChange') 592 593on(type: 'touchGuideStateChange', callback: Callback<boolean>): void 594 595监听触摸浏览功能启用状态变化事件，使用callback异步回调。 596 597**系统能力**：SystemCapability.BarrierFree.Accessibility.Vision 598 599**参数：** 600 601| 参数名 | 类型 | 必填 | 说明 | 602| -------- | ----------------------- | ---- | ---------------------------------------- | 603| type | string | 是 | 监听的事件名，固定为‘touchGuideStateChange’，即触摸浏览启用状态变化事件。 | 604| callback | Callback<boolean> | 是 | 回调函数，在触摸浏览启用状态变化时将状态通过此函数进行通知。 | 605 606**示例：** 607 608```ts 609import accessibility from '@ohos.accessibility'; 610 611accessibility.on('touchGuideStateChange', (data: boolean) => { 612 console.info(`subscribe touch guide state change, result: ${JSON.stringify(data)}`); 613}); 614``` 615 616## accessibility.off('accessibilityStateChange') 617 618off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void 619 620取消监听辅助应用启用状态变化事件，使用callback异步回调。 621 622**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 623 624**参数：** 625 626| 参数名 | 类型 | 必填 | 说明 | 627| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 628| type | string | 是 | 取消监听的事件名，固定为‘accessibilityStateChange’，即辅助应用启用状态变化事件。 | 629| callback | Callback<boolean> | 否 | 回调函数，取消指定callback对象的事件响应。需与accessibility.on('accessibilityStateChange')的callback一致。缺省时，表示注销所有已注册事件。 | 630 631**示例：** 632 633```ts 634import accessibility from '@ohos.accessibility'; 635 636accessibility.off('accessibilityStateChange', (data: boolean) => { 637 console.info(`Unsubscribe accessibility state change, result: ${JSON.stringify(data)}`); 638}); 639``` 640 641## accessibility.off('touchGuideStateChange') 642 643off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void 644 645取消监听触摸浏览启用状态变化事件，使用callback异步回调。 646 647**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 648 649**参数：** 650 651| 参数名 | 类型 | 必填 | 说明 | 652| -------- | ----------------------- | ---- | ------------------------------------------------------------ | 653| type | string | 是 | 取消监听的事件名，固定为‘touchGuideStateChange’，即触摸浏览启用状态变化事件。 | 654| callback | Callback<boolean> | 否 | 回调函数，取消指定callback对象的事件响应。需与accessibility.on('touchGuideStateChange')的callback一致。缺省时，表示注销所有已注册事件。 | 655 656**示例：** 657 658```ts 659import accessibility from '@ohos.accessibility'; 660 661accessibility.off('touchGuideStateChange', (data: boolean) => { 662 console.info(`Unsubscribe touch guide state change, result: ${JSON.stringify(data)}`); 663}); 664``` 665 666## accessibility.isOpenAccessibility<sup>(deprecated)</sup> 667 668isOpenAccessibility(): Promise<boolean> 669 670判断是否启用了辅助功能, 使用Promise异步回调。 671 672> **说明：** 673> 674> 从API version 10开始废弃。 675> 676> 推荐使用[accessibility.isOpenAccessibilitySync](#accessibilityisopenaccessibilitysync10)。 677 678**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 679 680**返回值：** 681 682| 类型 | 说明 | 683| ---------------------- | ---------------------------------------- | 684| Promise<boolean> | Promise对象，如果辅助功能已启用，则返回 true；否则返回 false。 | 685 686**示例：** 687 688```ts 689import accessibility from '@ohos.accessibility'; 690import { BusinessError } from '@ohos.base'; 691 692accessibility.isOpenAccessibility().then((data: boolean) => { 693 console.info(`success data:isOpenAccessibility : ${JSON.stringify(data)}`) 694}).catch((err: BusinessError) => { 695 console.error(`failed to isOpenAccessibility, Code is ${err.code}, message is ${err.message}`); 696}); 697``` 698 699## accessibility.isOpenAccessibility<sup>(deprecated)</sup> 700 701isOpenAccessibility(callback: AsyncCallback<boolean>): void 702 703判断是否启用了辅助功能，使用callback异步回调。 704 705> **说明：** 706> 707> 从API version 10开始废弃。 708> 709> 推荐使用[accessibility.isOpenAccessibilitySync](#accessibilityisopenaccessibilitysync10)。 710 711**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 712 713**参数：** 714 715| 参数名 | 类型 | 必填 | 说明 | 716| -------- | ---------------------------- | ---- | ----------------------------------- | 717| callback | AsyncCallback<boolean> | 是 | 回调函数，如果辅助功能已启用，则返回 true；否则返回 false。 | 718 719**示例：** 720 721```ts 722import accessibility from '@ohos.accessibility'; 723import { BusinessError } from '@ohos.base'; 724 725accessibility.isOpenAccessibility((err: BusinessError, data: boolean) => { 726 if (err) { 727 console.error(`failed to isOpenAccessibility, Code is ${err.code}, message is ${err.message}`); 728 return; 729 } 730 console.info(`success data:isOpenAccessibility : ${JSON.stringify(data)}`); 731}); 732``` 733 734## accessibility.isOpenAccessibilitySync<sup>10+</sup> 735 736isOpenAccessibilitySync(): boolean 737 738是否启用了辅助功能。 739 740**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 741 742**返回值：** 743 744| 类型 | 说明 | 745| ----------- | ------------------------------------- | 746| boolean | 启用辅助功能返回true，否则返回false。 | 747 748**示例：** 749 750```ts 751import accessibility from '@ohos.accessibility'; 752import { BusinessError } from '@ohos.base'; 753 754let status: boolean = accessibility.isOpenAccessibilitySync(); 755``` 756 757## accessibility.isOpenTouchGuide<sup>(deprecated)</sup> 758 759isOpenTouchGuide(): Promise<boolean> 760 761判断触摸浏览模式是否开启, 使用Promise异步回调。 762 763> **说明：** 764> 765> 从API version 10开始废弃。 766> 767> 推荐使用[accessibility.isOpenTouchGuideSync](#accessibilityisopentouchguidesync10)。 768 769**系统能力**：SystemCapability.BarrierFree.Accessibility.Vision 770 771**返回值：** 772 773| 类型 | 说明 | 774| ---------------------- | ---------------------------------------- | 775| Promise<boolean> | Promise对象，如果触摸浏览模式已开启，则返回 true；否则返回 false。 | 776 777**示例：** 778 779```ts 780import accessibility from '@ohos.accessibility'; 781import { BusinessError } from '@ohos.base'; 782 783accessibility.isOpenTouchGuide().then((data: boolean) => { 784 console.info(`success data:isOpenTouchGuide : ${JSON.stringify(data)}`); 785}).catch((err: BusinessError) => { 786 console.error(`failed to isOpenTouchGuide, Code is ${err.code}, message is ${err.message}`); 787}); 788``` 789 790## accessibility.isOpenTouchGuide<sup>(deprecated)</sup> 791 792isOpenTouchGuide(callback: AsyncCallback<boolean>): void 793 794判断触摸浏览模式是否开启, 使用callback异步回调。 795 796> **说明：** 797> 798> 从API version 10开始废弃。 799> 800> 推荐使用[accessibility.isOpenTouchGuideSync](#accessibilityisopentouchguidesync10)。 801 802**系统能力**：SystemCapability.BarrierFree.Accessibility.Vision 803 804**参数：** 805 806| 参数名 | 类型 | 必填 | 说明 | 807| -------- | ---------------------------- | ---- | ------------------------------------- | 808| callback | AsyncCallback<boolean> | 是 | 回调函数，如果触摸浏览模式已开启，则返回 true；否则返回 false。 | 809 810**示例：** 811 812```ts 813import accessibility from '@ohos.accessibility'; 814import { BusinessError } from '@ohos.base'; 815 816accessibility.isOpenTouchGuide((err: BusinessError, data: boolean) => { 817 if (err) { 818 console.error(`failed to isOpenTouchGuide, Code is ${err.code}, message is ${err.message}`); 819 return; 820 } 821 console.info(`success data:isOpenTouchGuide : ${JSON.stringify(data)}`); 822}); 823``` 824 825## accessibility.isOpenTouchGuideSync<sup>10+</sup> 826 827isOpenTouchGuideSync(): boolean 828 829是否开启了触摸浏览模式。 830 831**系统能力**：SystemCapability.BarrierFree.Accessibility.Vision 832 833**返回值：** 834 835| 类型 | 说明 | 836| ------- | ------------------------------------- | 837| boolean | 启用辅助功能返回true，否则返回false。 | 838 839**示例：** 840 841```ts 842import accessibility from '@ohos.accessibility'; 843 844let status: boolean = accessibility.isOpenTouchGuideSync(); 845``` 846 847## accessibility.sendEvent<sup>(deprecated)</sup> 848 849sendEvent(event: EventInfo): Promise<void> 850 851发送无障碍事件, 使用Promise异步回调。 852 853> **说明：** 854> 855> 从API version 7开始支持，从API version 9开始废弃。 856> 推荐使用[accessibility.sendAccessibilityEvent()](#accessibilitysendaccessibilityevent9)。 857 858**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 859 860**参数：** 861 862| 参数名 | 类型 | 必填 | 说明 | 863| ----- | ----------------------- | ---- | -------- | 864| event | [EventInfo](#eventinfo) | 是 | 无障碍事件对象。 | 865 866**返回值：** 867 868| 类型 | 说明 | 869| ------------------- | ---------------- | 870| Promise<void> | 无返回结果的Promise对象。 | 871 872**示例：** 873 874```ts 875import accessibility from '@ohos.accessibility'; 876import { BusinessError } from '@ohos.base'; 877 878let eventInfo: accessibility.EventInfo = ({ 879 type: 'click', 880 bundleName: 'com.example.MyApplication', 881 triggerAction: 'click', 882}); 883 884accessibility.sendEvent(eventInfo).then(() => { 885 console.info(`Succeeded in send event,eventInfo is ${eventInfo}`); 886}).catch((err: BusinessError) => { 887 console.error(`failed to sendEvent, Code is ${err.code}, message is ${err.message}`); 888}); 889``` 890 891## accessibility.sendEvent<sup>(deprecated)</sup> 892 893sendEvent(event: EventInfo, callback: AsyncCallback<void>): void 894 895发送无障碍事件, 使用callback异步回调。 896 897> **说明：** 898> 899> 从API version 7开始支持，从API version 9开始废弃。 900> 推荐使用[accessibility.sendAccessibilityEvent()](#accessibilitysendaccessibilityevent9-1)。 901 902**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 903 904**参数：** 905 906| 参数名 | 类型 | 必填 | 说明 | 907| -------- | ------------------------- | ---- | ---------------------------------------- | 908| event | [EventInfo](#eventinfo) | 是 | 辅助事件对象。 | 909| callback | AsyncCallback<void> | 是 | 回调函数，如果发送无障碍事件失败，则 AsyncCallback中err有数据返回。 | 910 911**示例：** 912 913```ts 914import accessibility from '@ohos.accessibility'; 915import { BusinessError } from '@ohos.base'; 916 917let eventInfo: accessibility.EventInfo = ({ 918 type: 'click', 919 bundleName: 'com.example.MyApplication', 920 triggerAction: 'click', 921}); 922 923accessibility.sendEvent(eventInfo, (err: BusinessError) => { 924 if (err) { 925 console.error(`failed to sendEvent, Code is ${err.code}, message is ${err.message}`); 926 return; 927 } 928 console.info(`Succeeded in sendEvent, eventInfo is ${eventInfo}`); 929}); 930``` 931 932## accessibility.sendAccessibilityEvent<sup>9+</sup> 933 934sendAccessibilityEvent(event: EventInfo): Promise<void> 935 936发送无障碍事件, 使用Promise异步回调。 937 938**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 939 940**参数：** 941 942| 参数名 | 类型 | 必填 | 说明 | 943| ----- | ----------------------- | ---- | -------- | 944| event | [EventInfo](#eventinfo) | 是 | 无障碍事件对象。 | 945 946**返回值：** 947 948| 类型 | 说明 | 949| ------------------- | ---------------- | 950| Promise<void> | 无返回结果的Promise对象。 | 951 952**示例：** 953 954```ts 955import accessibility from '@ohos.accessibility'; 956import { BusinessError } from '@ohos.base'; 957 958let eventInfo: accessibility.EventInfo = ({ 959 type: 'click', 960 bundleName: 'com.example.MyApplication', 961 triggerAction: 'click', 962}); 963 964accessibility.sendAccessibilityEvent(eventInfo).then(() => { 965 console.info(`Succeeded in send event,eventInfo is ${eventInfo}`); 966}).catch((err: BusinessError) => { 967 console.error(`failed to send event , Code is ${err.code}, message is ${err.message}`); 968}); 969``` 970 971## accessibility.sendAccessibilityEvent<sup>9+</sup> 972 973sendAccessibilityEvent(event: EventInfo, callback: AsyncCallback<void>): void 974 975发送无障碍事件, 使用callback异步回调。 976 977**系统能力**：SystemCapability.BarrierFree.Accessibility.Core 978 979**参数：** 980 981| 参数名 | 类型 | 必填 | 说明 | 982| -------- | ------------------------- | ---- | ---------------------------------------- | 983| event | [EventInfo](#eventinfo) | 是 | 辅助事件对象。 | 984| callback | AsyncCallback<void> | 是 | 回调函数，如果发送无障碍事件失败，则 AsyncCallback中err有数据返回。 | 985 986**示例：** 987 988```ts 989import accessibility from '@ohos.accessibility'; 990import { BusinessError } from '@ohos.base'; 991 992let eventInfo: accessibility.EventInfo = ({ 993 type: 'click', 994 bundleName: 'com.example.MyApplication', 995 triggerAction: 'click', 996}); 997 998accessibility.sendAccessibilityEvent(eventInfo, (err: BusinessError) => { 999 if (err) { 1000 console.error(`failed to send event, Code is ${err.code}, message is ${err.message}`); 1001 return; 1002 } 1003 console.info(`Succeeded in send event, eventInfo is ${eventInfo}`); 1004}); 1005``` 1006