已合并
新旧文档一致性对比问题修复 #35215
wwwyyyhhhh创建于 10 天前
新旧文档一致性对比问题修复 #35215
已合并
共 12 个文件变更+163-116
| @@ -14,6 +14,10 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | + * GesturePath represents gesture path information. | ||
| 18 | + * | ||
| 19 | + * This module is used to create gesture path information for accessibility gesture injection. | ||
| 20 | + * | ||
| 17 | * Gesture Path | 21 | * Gesture Path |
| 18 | * AccessibilityKit | 22 | * AccessibilityKit |
| 19 | */ | 23 | */ |
| @@ -21,9 +25,8 @@ | |||
| 21 | import type { GesturePoint } from './@ohos.accessibility.GesturePoint'; | 25 | import type { GesturePoint } from './@ohos.accessibility.GesturePoint'; |
| 22 | 26 | ||
| 23 | /** | 27 | /** |
| 24 | - * GesturePath represents gesture path information. | 28 | + * Represents gesture path information, used to simulate user touch gestures (such as tap, swipe, etc.) in |
| 25 | - * | 29 | + * accessibility services. |
| 26 | - * This module is used to create gesture path information for accessibility gesture injection. | ||
| 27 | * | 30 | * |
| 28 | * SystemCapability.BarrierFree.Accessibility.Core | 31 | * SystemCapability.BarrierFree.Accessibility.Core |
| 29 | * 9 dynamiconly | 32 | * 9 dynamiconly |
| @@ -14,15 +14,19 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | + * GesturePoint represents a gesture touch point and is the basic unit that constitutes a gesture path (GesturePath). | ||
| 18 | + * | ||
| 19 | + * This module is used to create touch point information for gesture paths, for use by accessibility applications to | ||
| 20 | + * inject gestures. | ||
| 21 | + * | ||
| 17 | * Gesture Point | 22 | * Gesture Point |
| 18 | * AccessibilityKit | 23 | * AccessibilityKit |
| 19 | */ | 24 | */ |
| 20 | 25 | ||
| 21 | /** | 26 | /** |
| 22 | - * GesturePoint represents a gesture touch point and is the basic unit that constitutes a gesture path (GesturePath). | 27 | + * Represents a gesture touch point, which is the basic unit that constitutes a GesturePath node and is used to define |
| 23 | - * | 28 | + * the touch position in the gesture trajectory for accessibility gesture injection. For details about how to use it, |
| 24 | - * This module is used to create touch point information for gesture paths, for use by accessibility applications to | 29 | + * see [GesturePath]{@link @ohos.accessibility.GesturePath}. |
| 25 | - * inject gestures. | ||
| 26 | * | 30 | * |
| 27 | * SystemCapability.BarrierFree.Accessibility.Core | 31 | * SystemCapability.BarrierFree.Accessibility.Core |
| 28 | * 9 dynamiconly | 32 | * 9 dynamiconly |
| @@ -24,10 +24,6 @@ import type { AsyncCallback, Callback } from './@ohos.base'; | |||
| 24 | /** | 24 | /** |
| 25 | * The **accessibility.config** module provides APIs for configuring system accessibility features, including | 25 | * The **accessibility.config** module provides APIs for configuring system accessibility features, including |
| 26 | * accessibility extension, high-contrast text, mouse buttons, and captions. | 26 | * accessibility extension, high-contrast text, mouse buttons, and captions. |
| 27 | - * | ||
| 28 | - * > **NOTE** | ||
| 29 | - * > | ||
| 30 | - * > - The APIs of this module are system APIs. | ||
| 31 | * | 27 | * |
| 32 | * SystemCapability.BarrierFree.Accessibility.Core | 28 | * SystemCapability.BarrierFree.Accessibility.Core |
| 33 | * | 29 | * |
| @@ -907,6 +903,8 @@ declare namespace config { | |||
| 907 | type OnDisconnectCallback = () => void; | 903 | type OnDisconnectCallback = () => void; |
| 908 | 904 | ||
| 909 | /** | 905 | /** |
| 906 | + * Color correction filters for different types of color vision deficiency. | ||
| 907 | + * | ||
| 910 | * The configuration takes effect when the daltonization feature is enabled ( | 908 | * The configuration takes effect when the daltonization feature is enabled ( |
| 911 | * [daltonizationState]{ config.daltonizationState} is set to **true**). When the daltonization feature is | 909 | * [daltonizationState]{ config.daltonizationState} is set to **true**). When the daltonization feature is |
| 912 | * disabled ([daltonizationState]{ config.daltonizationState} is set to **false**), the standard type is | 910 | * disabled ([daltonizationState]{ config.daltonizationState} is set to **false**), the standard type is |
| @@ -937,6 +935,8 @@ declare namespace config { | |||
| 937 | type ClickResponseTime = 'Short' | 'Medium' | 'Long'; | 935 | type ClickResponseTime = 'Short' | 'Medium' | 'Long'; |
| 938 | 936 | ||
| 939 | /** | 937 | /** |
| 938 | + * Ignore repeated clicks at different time intervals. | ||
| 939 | + * | ||
| 940 | * The configuration takes effect when the ignore repeated click feature is enabled ( | 940 | * The configuration takes effect when the ignore repeated click feature is enabled ( |
| 941 | * [ignoreRepeatClick]{ config.ignoreRepeatClick} is set to **true**). When the ignore repeated click feature is | 941 | * [ignoreRepeatClick]{ config.ignoreRepeatClick} is set to **true**). When the ignore repeated click feature is |
| 942 | * disabled ([ignoreRepeatClick]{ config.ignoreRepeatClick} is set to **false**), the configuration does not take | 942 | * disabled ([ignoreRepeatClick]{ config.ignoreRepeatClick} is set to **false**), the configuration does not take |
| @@ -1040,7 +1040,9 @@ export enum AccessibilityEventType { | |||
| 1040 | } | 1040 | } |
| 1041 | 1041 | ||
| 1042 | /** | 1042 | /** |
| 1043 | - * Accessibility | 1043 | + * This module provides accessibility features, including obtaining the accessibility application list, obtaining the |
| 1044 | + * accessibility application enabling state, obtaining the captions configuration, sending accessibility events, and | ||
| 1045 | + * listening for accessibility application state changes. | ||
| 1044 | * | 1046 | * |
| 1045 | * SystemCapability.BarrierFree.Accessibility.Core | 1047 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1046 | * [since 20] | 1048 | * [since 20] |
| @@ -124,7 +124,8 @@ export type WindowType = _WindowType; | |||
| 124 | export type Rect = _Rect; | 124 | export type Rect = _Rect; |
| 125 | 125 | ||
| 126 | /** | 126 | /** |
| 127 | - * Indicates executeAction parameter. | 127 | + * Provides parameter values for specific settings when an accessibility node element performs a specific action. For |
| 128 | + * details, see [Parameter]{ ./application/AccessibilityExtensionContext:Parameter}. | ||
| 128 | * | 129 | * |
| 129 | * SystemCapability.BarrierFree.Accessibility.Core | 130 | * SystemCapability.BarrierFree.Accessibility.Core |
| 130 | * | 131 | * |
| @@ -143,7 +144,8 @@ export type Parameter = _Parameter; | |||
| 143 | export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; | 144 | export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; |
| 144 | 145 | ||
| 145 | /** | 146 | /** |
| 146 | - * Indicates the rule of the search focus. | 147 | + * Describes how to determine the focus capability of the starting node and its child nodes when searching for |
| 148 | + * focusable nodes. For details, see [FocusRule]{ ./application/AccessibilityExtensionContext:FocusRule}. | ||
| 147 | * | 149 | * |
| 148 | * SystemCapability.BarrierFree.Accessibility.Core | 150 | * SystemCapability.BarrierFree.Accessibility.Core |
| 149 | * | 151 | * |
| @@ -152,7 +154,8 @@ export type AccessibilityExtensionContext = _AccessibilityExtensionContext.defau | |||
| 152 | export type FocusRule = _FocusRule; | 154 | export type FocusRule = _FocusRule; |
| 153 | 155 | ||
| 154 | /** | 156 | /** |
| 155 | - * Indicates the condition of the search focus. | 157 | + * Describes the method for querying focusable nodes. For details, see |
| 158 | + * [FocusCondition]{ ./application/AccessibilityExtensionContext:FocusCondition}. | ||
| 156 | * | 159 | * |
| 157 | * SystemCapability.BarrierFree.Accessibility.Core | 160 | * SystemCapability.BarrierFree.Accessibility.Core |
| 158 | * | 161 | * |
| @@ -161,7 +164,8 @@ export type FocusRule = _FocusRule; | |||
| 161 | export type FocusCondition = _FocusCondition; | 164 | export type FocusCondition = _FocusCondition; |
| 162 | 165 | ||
| 163 | /** | 166 | /** |
| 164 | - * Indicates focus move result. | 167 | + * Return value type of the accessibility node query. For details, see |
| 168 | + * [FocusMoveResult]{ ./application/AccessibilityExtensionContext:FocusMoveResult}. | ||
| 165 | * | 169 | * |
| 166 | * SystemCapability.BarrierFree.Accessibility.Core | 170 | * SystemCapability.BarrierFree.Accessibility.Core |
| 167 | * | 171 | * |
| @@ -170,7 +174,8 @@ export type FocusCondition = _FocusCondition; | |||
| 170 | export type FocusMoveResult = _FocusMoveResult; | 174 | export type FocusMoveResult = _FocusMoveResult; |
| 171 | 175 | ||
| 172 | /** | 176 | /** |
| 173 | - * Indicates the accessibility virtual node. | 177 | + * Defines an accessibility virtual node. For details, see |
| 178 | + * [AccessibilityVirtualNode]{ ./application/AccessibilityExtensionContext:AccessibilityVirtualNode}. | ||
| 174 | * | 179 | * |
| 175 | * SystemCapability.BarrierFree.Accessibility.Core | 180 | * SystemCapability.BarrierFree.Accessibility.Core |
| 176 | * | 181 | * |
| @@ -180,7 +185,8 @@ export type FocusMoveResult = _FocusMoveResult; | |||
| 180 | export type AccessibilityVirtualNode = _AccessibilityVirtualNode; | 185 | export type AccessibilityVirtualNode = _AccessibilityVirtualNode; |
| 181 | 186 | ||
| 182 | /** | 187 | /** |
| 183 | - * The touch position of an accessibility virtual node. | 188 | + * Touch tap position. For details, see |
| 189 | + * [TouchPosition]{ ./application/AccessibilityExtensionContext:TouchPosition}. | ||
| 184 | * | 190 | * |
| 185 | * SystemCapability.BarrierFree.Accessibility.Core | 191 | * SystemCapability.BarrierFree.Accessibility.Core |
| 186 | * | 192 | * |
| @@ -190,16 +196,23 @@ export type AccessibilityVirtualNode = _AccessibilityVirtualNode; | |||
| 190 | export type TouchPosition = _TouchPosition; | 196 | export type TouchPosition = _TouchPosition; |
| 191 | 197 | ||
| 192 | /** | 198 | /** |
| 193 | - * The accessibility extension context. Used to configure, query information, and inject gestures. | 199 | + * The accessibility extension context. For details, see |
| 200 | + * [AccessibilityExtensionContext]{ ./application/AccessibilityExtensionContext:AccessibilityExtensionContext}. | ||
| 194 | * | 201 | * |
| 195 | * SystemCapability.BarrierFree.Accessibility.Core | 202 | * SystemCapability.BarrierFree.Accessibility.Core |
| 196 | * 23 static | 203 | * 23 static |
| 197 | */ | 204 | */ |
| 205 | + | ||
| 198 | export { AccessibilityExtensionContext }; | 206 | export { AccessibilityExtensionContext }; |
| 199 | 207 | ||
| 200 | /** | 208 | /** |
| 201 | - * AccessibilityExtensionAbility provides the accessibility extension service capability based on the ExtensionAbility | 209 | + * AccessibilityExtensionAbility provides accessibility extension capabilities based on the ExtensionAbility framework, |
| 202 | - * framework. | 210 | + * including connecting to and disconnecting from accessibility services, processing accessibility events, and |
| 211 | + * processing accessibility key events. | ||
| 212 | + * | ||
| 213 | + * **Lifecycle flow:** onAccessibilityConnect (connection callback, used for initialization) → | ||
| 214 | + * onAccessibilityEventInfo/onAccessibilityKeyEvent (processing accessibility events and key events) → | ||
| 215 | + * onAccessibilityDisconnect (disconnection callback, used for resource reclamation). | ||
| 203 | * | 216 | * |
| 204 | * SystemCapability.BarrierFree.Accessibility.Core | 217 | * SystemCapability.BarrierFree.Accessibility.Core |
| 205 | * 9 dynamic | 218 | * 9 dynamic |
| @@ -14,19 +14,8 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | - * ###### Usage | 17 | + * The Accessibility Extension Context module provides a context environment, supporting accessibility apps in |
| 18 | - * | 18 | + * configuring information types of interest, querying node information, gesture injection, and more. |
| 19 | - * Before using AccessibilityExtensionContext, obtain an AccessibilityExtensionContext instance through an | ||
| 20 | - * AccessibilityExtensionAbility subclass instance. | ||
| 21 | - * | ||
| 22 | - * ```ts | ||
| 23 | - * import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit'; | ||
| 24 | - * class EntryAbility extends AccessibilityExtensionAbility { | ||
| 25 | - * onConnect(): void { | ||
| 26 | - * let axContext = this.context; | ||
| 27 | - * } | ||
| 28 | - * } | ||
| 29 | - * ``` | ||
| 30 | * | 19 | * |
| 31 | * Provides accessibility extension context | 20 | * Provides accessibility extension context |
| 32 | * AccessibilityKit | 21 | * AccessibilityKit |
| @@ -49,6 +38,20 @@ import { AccessibilityAction, FocusMoveResultCode, InjectActionType, | |||
| 49 | * | 38 | * |
| 50 | * The Accessibility Extension Context module provides capabilities related to the accessibility extension, including | 39 | * The Accessibility Extension Context module provides capabilities related to the accessibility extension, including |
| 51 | * configuring concerned information types, querying node information, and gesture injection. | 40 | * configuring concerned information types, querying node information, and gesture injection. |
| 41 | + * | ||
| 42 | + * ###### Usage | ||
| 43 | + * | ||
| 44 | + * Before using AccessibilityExtensionContext, obtain an AccessibilityExtensionContext instance through an | ||
| 45 | + * AccessibilityExtensionAbility subclass instance. | ||
| 46 | + * | ||
| 47 | + * ```ts | ||
| 48 | + * import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit'; | ||
| 49 | + * class EntryAbility extends AccessibilityExtensionAbility { | ||
| 50 | + * onConnect(): void { | ||
| 51 | + * let axContext = this.context; | ||
| 52 | + * } | ||
| 53 | + * } | ||
| 54 | + * ``` | ||
| 52 | * | 55 | * |
| 53 | * SystemCapability.BarrierFree.Accessibility.Core | 56 | * SystemCapability.BarrierFree.Accessibility.Core |
| 54 | * 9 dynamic | 57 | * 9 dynamic |
| @@ -629,9 +632,9 @@ export default AccessibilityExtensionContext; | |||
| 629 | * accessibility app needs to interact with and operate on UI nodes. | 632 | * accessibility app needs to interact with and operate on UI nodes. |
| 630 | * | 633 | * |
| 631 | * Before calling methods of AccessibilityElement, obtain an AccessibilityElement instance through | 634 | * Before calling methods of AccessibilityElement, obtain an AccessibilityElement instance through |
| 632 | - * [AccessibilityExtensionContext.getFocusElement()]{@link AccessibilityExtensionContext#getFocusElement(isAccessibilityFocus?: boolean)} | 635 | + * [AccessibilityExtensionContext.getAccessibilityFocusedElement()]{@link AccessibilityExtensionContext.getAccessibilityFocusedElement} |
| 633 | * or | 636 | * or |
| 634 | - * [AccessibilityExtensionContext.getWindowRootElement()]{@link AccessibilityExtensionContext#getWindowRootElement(windowId?: int)}. | 637 | + * [AccessibilityExtensionContext.getRootInActiveWindow()]{@link AccessibilityExtensionContext.getRootInActiveWindow}. |
| 635 | * | 638 | * |
| 636 | * SystemCapability.BarrierFree.Accessibility.Core | 639 | * SystemCapability.BarrierFree.Accessibility.Core |
| 637 | * | 640 | * |
| @@ -2755,7 +2758,8 @@ export interface ElementAttributeValues { | |||
| 2755 | */ | 2758 | */ |
| 2756 | customActions?: Array<string>; | 2759 | customActions?: Array<string>; |
| 2757 | /** | 2760 | /** |
| 2758 | - * Indicates the source of this element. | 2761 | + * Source type of the component, used to distinguish default components from newly added or modified virtual |
| 2762 | + * components. | ||
| 2759 | * | 2763 | * |
| 2760 | * SystemCapability.BarrierFree.Accessibility.Core | 2764 | * SystemCapability.BarrierFree.Accessibility.Core |
| 2761 | * | 2765 | * |
| @@ -14,6 +14,10 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | + * GesturePath表示手势路径信息。 | ||
| 18 | + * | ||
| 19 | + * 本模块用于创建手势路径信息,供辅助功能注入手势使用。 | ||
| 20 | + * | ||
| 17 | * 手势路径 | 21 | * 手势路径 |
| 18 | * AccessibilityKit | 22 | * AccessibilityKit |
| 19 | */ | 23 | */ |
| @@ -21,9 +25,7 @@ | |||
| 21 | import type { GesturePoint } from './@ohos.accessibility.GesturePoint'; | 25 | import type { GesturePoint } from './@ohos.accessibility.GesturePoint'; |
| 22 | 26 | ||
| 23 | /** | 27 | /** |
| 24 | - * GesturePath表示手势路径信息。 | 28 | + * 表示手势路径信息,用于无障碍服务中模拟用户触摸手势(如点击、滑动等)。 |
| 25 | - * | ||
| 26 | - * 本模块用于创建手势路径信息,供辅助功能注入手势使用。 | ||
| 27 | * | 29 | * |
| 28 | * SystemCapability.BarrierFree.Accessibility.Core | 30 | * SystemCapability.BarrierFree.Accessibility.Core |
| 29 | * 9 dynamiconly | 31 | * 9 dynamiconly |
| @@ -14,14 +14,16 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | + * GesturePoint表示手势触摸点,是构成手势路径GesturePath的基本单元。 | ||
| 18 | + * | ||
| 19 | + * 本模块用于创建手势路径的触摸点信息,供辅助功能注入手势使用。 | ||
| 20 | + * | ||
| 17 | * 手势触摸点 | 21 | * 手势触摸点 |
| 18 | * AccessibilityKit | 22 | * AccessibilityKit |
| 19 | */ | 23 | */ |
| 20 | 24 | ||
| 21 | /** | 25 | /** |
| 22 | - * GesturePoint表示手势触摸点,是构成手势路径GesturePath的基本单元。 | 26 | + * 表示手势触摸点,是构成GesturePath路径节点的基本单元,用于定义辅助功能注入手势轨迹中的触摸位置。详细使用方式请参见[GesturePath]{@link @ohos.accessibility.GesturePath}。 |
| 23 | - * | ||
| 24 | - * 本模块用于创建手势路径的触摸点信息,供辅助功能注入手势使用。 | ||
| 25 | * | 27 | * |
| 26 | * SystemCapability.BarrierFree.Accessibility.Core | 28 | * SystemCapability.BarrierFree.Accessibility.Core |
| 27 | * 9 dynamiconly | 29 | * 9 dynamiconly |
| @@ -202,7 +202,7 @@ declare namespace config { | |||
| 202 | */ | 202 | */ |
| 203 | const repeatClickInterval: Config<RepeatClickInterval>; | 203 | const repeatClickInterval: Config<RepeatClickInterval>; |
| 204 | /** | 204 | /** |
| 205 | - * Indicates the configuration of screen magnification. | 205 | + * 表示屏幕放大功能启用状态。 |
| 206 | * | 206 | * |
| 207 | * SystemCapability.BarrierFree.Accessibility.Core | 207 | * SystemCapability.BarrierFree.Accessibility.Core |
| 208 | * | 208 | * |
| @@ -358,10 +358,10 @@ declare namespace config { | |||
| 358 | function on(type: 'enabledAccessibilityExtensionListChange', callback: Callback<void>): void; | 358 | function on(type: 'enabledAccessibilityExtensionListChange', callback: Callback<void>): void; |
| 359 | 359 | ||
| 360 | /** | 360 | /** |
| 361 | - * Register the listener that watches for changes in the enabled status of accessibility extensions. | 361 | + * 添加启用的辅助扩展的列表变化监听。使用callback异步回调。 |
| 362 | * | 362 | * |
| 363 | * ohos.permission.READ_ACCESSIBILITY_CONFIG | 363 | * ohos.permission.READ_ACCESSIBILITY_CONFIG |
| 364 | - * @param { Callback<void> } callback Indicates the listener. | 364 | + * @param { Callback<void> } callback - 回调函数,在启用的辅助扩展的列表变化时通过此函数进行通知。 |
| 365 | * { BusinessError } 201 - Permission verification failed. | 365 | * { BusinessError } 201 - Permission verification failed. |
| 366 | * The application does not have the permission required to call the API. | 366 | * The application does not have the permission required to call the API. |
| 367 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 367 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -395,10 +395,10 @@ declare namespace config { | |||
| 395 | function on(type: 'installedAccessibilityListChange', callback: Callback<void>): void; | 395 | function on(type: 'installedAccessibilityListChange', callback: Callback<void>): void; |
| 396 | 396 | ||
| 397 | /** | 397 | /** |
| 398 | - * Register the listener that watches for changes in the installed status of accessibility extensions. | 398 | + * 添加已安装的辅助扩展的列表变化监听。使用callback异步回调。 |
| 399 | * | 399 | * |
| 400 | * ohos.permission.READ_ACCESSIBILITY_CONFIG | 400 | * ohos.permission.READ_ACCESSIBILITY_CONFIG |
| 401 | - * @param { Callback<void> } callback Indicates the listener. | 401 | + * @param { Callback<void> } callback - 回调函数,在已安装的辅助扩展的列表变化时通过此函数进行通知。 |
| 402 | * { BusinessError } 201 - Permission verification failed. | 402 | * { BusinessError } 201 - Permission verification failed. |
| 403 | * The application does not have the permission required to call the API. | 403 | * The application does not have the permission required to call the API. |
| 404 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 404 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -430,10 +430,11 @@ declare namespace config { | |||
| 430 | function off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback<void>): void; | 430 | function off(type: 'enabledAccessibilityExtensionListChange', callback?: Callback<void>): void; |
| 431 | 431 | ||
| 432 | /** | 432 | /** |
| 433 | - * Unregister listener that watches for changes in the enabled status of accessibility extensions. | 433 | + * 取消启用的辅助扩展的列表变化监听。使用callback异步回调。 |
| 434 | * | 434 | * |
| 435 | * ohos.permission.READ_ACCESSIBILITY_CONFIG | 435 | * ohos.permission.READ_ACCESSIBILITY_CONFIG |
| 436 | - * @param { Callback<void> } [callback] Indicates the listener. | 436 | + * @param { Callback<void> } callback - 取消指定callback对象的事件响应。需与onEnabledAccessibilityExtensionListChange的callback一致。缺省 |
| 437 | + * 时,表示注销所有已注册事件。 | ||
| 437 | * { BusinessError } 201 - Permission verification failed. | 438 | * { BusinessError } 201 - Permission verification failed. |
| 438 | * The application does not have the permission required to call the API. | 439 | * The application does not have the permission required to call the API. |
| 439 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 440 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -465,10 +466,11 @@ declare namespace config { | |||
| 465 | function off(type: 'installedAccessibilityListChange', callback?: Callback<void>): void; | 466 | function off(type: 'installedAccessibilityListChange', callback?: Callback<void>): void; |
| 466 | 467 | ||
| 467 | /** | 468 | /** |
| 468 | - * Unregister listener that watches for changes in the installed status of accessibility extensions. | 469 | + * 取消已安装的辅助扩展的列表变化监听。使用callback异步回调。 |
| 469 | * | 470 | * |
| 470 | * ohos.permission.READ_ACCESSIBILITY_CONFIG | 471 | * ohos.permission.READ_ACCESSIBILITY_CONFIG |
| 471 | - * @param { Callback<void> } [callback] Indicates the listener. | 472 | + * @param { Callback<void> } callback - 取消指定callback对象的事件响应。需与onInstalledAccessibilityListChange的callback一致。缺省时,表示注销所有 |
| 473 | + * 已注册事件。 | ||
| 472 | * { BusinessError } 201 - Permission verification failed. | 474 | * { BusinessError } 201 - Permission verification failed. |
| 473 | * The application does not have the permission required to call the API. | 475 | * The application does not have the permission required to call the API. |
| 474 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 476 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -813,6 +815,8 @@ declare namespace config { | |||
| 813 | type OnDisconnectCallback = () => void; | 815 | type OnDisconnectCallback = () => void; |
| 814 | 816 | ||
| 815 | /** | 817 | /** |
| 818 | + * 用于不同色弱类型的校正颜色滤镜。 | ||
| 819 | + * | ||
| 816 | * 色彩校正功能启用时([daltonizationState]{ config.daltonizationState}设置为true)配置生效;色彩校正功能未启用时( | 820 | * 色彩校正功能启用时([daltonizationState]{ config.daltonizationState}设置为true)配置生效;色彩校正功能未启用时( |
| 817 | * [daltonizationState]{ config.daltonizationState}设置为false)显示为正常类型。 | 821 | * [daltonizationState]{ config.daltonizationState}设置为false)显示为正常类型。 |
| 818 | * | 822 | * |
| @@ -841,6 +845,8 @@ declare namespace config { | |||
| 841 | type ClickResponseTime = 'Short' | 'Medium' | 'Long'; | 845 | type ClickResponseTime = 'Short' | 'Medium' | 'Long'; |
| 842 | 846 | ||
| 843 | /** | 847 | /** |
| 848 | + * 用于不同时间间隔的忽略重复点击。 | ||
| 849 | + * | ||
| 844 | * 忽略重复点击功能启用时([ignoreRepeatClick]{ config.ignoreRepeatClick}设置为true)配置生效;忽略重复点击功能未启用时( | 850 | * 忽略重复点击功能启用时([ignoreRepeatClick]{ config.ignoreRepeatClick}设置为true)配置生效;忽略重复点击功能未启用时( |
| 845 | * [ignoreRepeatClick]{ config.ignoreRepeatClick}设置为false)不生效。 | 851 | * [ignoreRepeatClick]{ config.ignoreRepeatClick}设置为false)不生效。 |
| 846 | * | 852 | * |
| @@ -24,7 +24,7 @@ import type { AsyncCallback } from './@ohos.base'; | |||
| 24 | import type { Callback } from './@ohos.base'; | 24 | import type { Callback } from './@ohos.base'; |
| 25 | 25 | ||
| 26 | /** | 26 | /** |
| 27 | - * 辅助功能 | 27 | + * 本模块提供辅助功能相关能力,包括获取辅助应用列表、获取辅助应用启用状态、获取无障碍字幕配置、发送无障碍事件、监听辅助应用状态变化等。 |
| 28 | * | 28 | * |
| 29 | * SystemCapability.BarrierFree.Accessibility.Core | 29 | * SystemCapability.BarrierFree.Accessibility.Core |
| 30 | * [since 20] | 30 | * [since 20] |
| @@ -446,9 +446,9 @@ declare namespace accessibility { | |||
| 446 | function on(type: 'accessibilityStateChange', callback: Callback<boolean>): void; | 446 | function on(type: 'accessibilityStateChange', callback: Callback<boolean>): void; |
| 447 | 447 | ||
| 448 | /** | 448 | /** |
| 449 | - * Register the observe of the accessibility state changed. | 449 | + * 监听辅助应用启用状态变化事件。使用callback异步回调。 |
| 450 | * | 450 | * |
| 451 | - * @param { Callback<boolean> } callback Asynchronous callback interface. | 451 | + * @param { Callback<boolean> } callback - 回调函数,在辅助应用启用状态变化时将状态通过此函数进行通知。此状态为全局辅助应用启用状态。 |
| 452 | * SystemCapability.BarrierFree.Accessibility.Core | 452 | * SystemCapability.BarrierFree.Accessibility.Core |
| 453 | * | 453 | * |
| 454 | * | 454 | * |
| @@ -486,9 +486,9 @@ declare namespace accessibility { | |||
| 486 | function on(type: 'touchGuideStateChange', callback: Callback<boolean>): void; | 486 | function on(type: 'touchGuideStateChange', callback: Callback<boolean>): void; |
| 487 | 487 | ||
| 488 | /** | 488 | /** |
| 489 | - * Register the observe of the touchGuide state changed. | 489 | + * 监听触摸浏览功能启用状态变化事件。使用callback异步回调。 |
| 490 | * | 490 | * |
| 491 | - * @param { Callback<boolean> } callback Asynchronous callback interface. | 491 | + * @param { Callback<boolean> } callback - 回调函数,在触摸浏览启用状态变化时将状态通过此函数进行通知。 |
| 492 | * SystemCapability.BarrierFree.Accessibility.Vision | 492 | * SystemCapability.BarrierFree.Accessibility.Vision |
| 493 | * | 493 | * |
| 494 | * | 494 | * |
| @@ -520,9 +520,10 @@ declare namespace accessibility { | |||
| 520 | function off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void; | 520 | function off(type: 'accessibilityStateChange', callback?: Callback<boolean>): void; |
| 521 | 521 | ||
| 522 | /** | 522 | /** |
| 523 | - * Unregister the observe of the accessibility state changed. | 523 | + * 取消监听辅助应用启用状态变化事件。使用callback异步回调。 |
| 524 | * | 524 | * |
| 525 | - * @param { Callback<boolean> } [callback] Asynchronous callback interface. | 525 | + * @param { Callback<boolean> } [callback] - 回调函数,取消指定callback对象的事件响应。需与accessibility.onAccessibilityStateChange的 |
| 526 | + * callback一致。缺省时,表示注销所有已注册事件。 | ||
| 526 | * SystemCapability.BarrierFree.Accessibility.Core | 527 | * SystemCapability.BarrierFree.Accessibility.Core |
| 527 | * | 528 | * |
| 528 | * | 529 | * |
| @@ -551,9 +552,10 @@ declare namespace accessibility { | |||
| 551 | function off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void; | 552 | function off(type: 'touchGuideStateChange', callback?: Callback<boolean>): void; |
| 552 | 553 | ||
| 553 | /** | 554 | /** |
| 554 | - * Unregister the observe of the touchGuide state changed. | 555 | + * 取消监听触摸浏览启用状态变化事件。使用callback异步回调。 |
| 555 | * | 556 | * |
| 556 | - * @param { Callback<boolean> } [callback] Asynchronous callback interface. | 557 | + * @param { Callback<boolean> } [callback] - 回调函数,取消指定callback对象的事件响应。需与accessibility.onTouchGuideStateChange的callback |
| 558 | + * 一致。缺省时,表示注销所有已注册事件。 | ||
| 557 | * SystemCapability.BarrierFree.Accessibility.Core | 559 | * SystemCapability.BarrierFree.Accessibility.Core |
| 558 | * | 560 | * |
| 559 | * | 561 | * |
| @@ -627,9 +629,9 @@ declare namespace accessibility { | |||
| 627 | on(type: 'enableChange', callback: Callback<boolean>): void; | 629 | on(type: 'enableChange', callback: Callback<boolean>): void; |
| 628 | 630 | ||
| 629 | /** | 631 | /** |
| 630 | - * Register the observe of the enable state. | 632 | + * 监听字幕配置启用状态变化事件。使用callback异步回调。 |
| 631 | * | 633 | * |
| 632 | - * @param { Callback<boolean> } callback | 634 | + * @param { Callback<boolean> } callback - 回调函数,在启用状态变化时将状态通过此函数进行通知。 |
| 633 | * SystemCapability.BarrierFree.Accessibility.Hearing | 635 | * SystemCapability.BarrierFree.Accessibility.Hearing |
| 634 | * 23 static | 636 | * 23 static |
| 635 | */ | 637 | */ |
| @@ -659,9 +661,9 @@ declare namespace accessibility { | |||
| 659 | on(type: 'styleChange', callback: Callback<CaptionsStyle>): void; | 661 | on(type: 'styleChange', callback: Callback<CaptionsStyle>): void; |
| 660 | 662 | ||
| 661 | /** | 663 | /** |
| 662 | - * Register the observer of the style. | 664 | + * 监听字幕风格变化事件。使用callback异步回调。 |
| 663 | * | 665 | * |
| 664 | - * @param { Callback<CaptionsStyle> } callback | 666 | + * @param { Callback<CaptionsStyle> } callback - 回调函数,在字幕风格变化时通过此函数进行通知。 |
| 665 | * SystemCapability.BarrierFree.Accessibility.Hearing | 667 | * SystemCapability.BarrierFree.Accessibility.Hearing |
| 666 | * 23 static | 668 | * 23 static |
| 667 | */ | 669 | */ |
| @@ -685,9 +687,9 @@ declare namespace accessibility { | |||
| 685 | off(type: 'enableChange', callback?: Callback<boolean>): void; | 687 | off(type: 'enableChange', callback?: Callback<boolean>): void; |
| 686 | 688 | ||
| 687 | /** | 689 | /** |
| 688 | - * Unregister the observe of the enable state. | 690 | + * 取消监听字幕配置启用状态变化事件。使用callback异步回调。 |
| 689 | * | 691 | * |
| 690 | - * @param { Callback<boolean> } [callback] | 692 | + * @param { Callback<boolean> } [callback] - 回调函数,取消指定callback对象的事件响应。需与onEnableChange的callback一致。缺省时,表示注销所有已注册事件。 |
| 691 | * SystemCapability.BarrierFree.Accessibility.Hearing | 693 | * SystemCapability.BarrierFree.Accessibility.Hearing |
| 692 | * 23 static | 694 | * 23 static |
| 693 | */ | 695 | */ |
| @@ -711,9 +713,10 @@ declare namespace accessibility { | |||
| 711 | off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void; | 713 | off(type: 'styleChange', callback?: Callback<CaptionsStyle>): void; |
| 712 | 714 | ||
| 713 | /** | 715 | /** |
| 714 | - * Unregister the observer of the style. | 716 | + * 取消字幕风格变化监听事件。使用callback异步回调。 |
| 715 | * | 717 | * |
| 716 | - * @param { Callback<CaptionsStyle> } [callback] | 718 | + * @param { Callback<CaptionsStyle> } [callback] - 回调函数,取消指定callback对象的事件响应。需与onStyleChange的callback一致。缺省时,表示注销所有已注册 |
| 719 | + * 事件。 | ||
| 717 | * SystemCapability.BarrierFree.Accessibility.Hearing | 720 | * SystemCapability.BarrierFree.Accessibility.Hearing |
| 718 | * 23 static | 721 | * 23 static |
| 719 | */ | 722 | */ |
| @@ -999,7 +1002,7 @@ declare namespace accessibility { | |||
| 999 | constructor(jsonObject: Object); | 1002 | constructor(jsonObject: Object); |
| 1000 | 1003 | ||
| 1001 | /** | 1004 | /** |
| 1002 | - * A constructor used to create a EventInfo object. | 1005 | + * 构造函数。 |
| 1003 | * | 1006 | * |
| 1004 | * SystemCapability.BarrierFree.Accessibility.Core | 1007 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1005 | * | 1008 | * |
| @@ -1302,9 +1305,10 @@ declare namespace accessibility { | |||
| 1302 | function off(type: 'screenReaderStateChange', callback?: Callback<boolean>): void; | 1305 | function off(type: 'screenReaderStateChange', callback?: Callback<boolean>): void; |
| 1303 | 1306 | ||
| 1304 | /** | 1307 | /** |
| 1305 | - * Unregister the observe of the screen reader state changed. | 1308 | + * 取消监听屏幕朗读启用状态变化事件。使用callback异步回调。 |
| 1306 | * | 1309 | * |
| 1307 | - * @param { Callback<boolean> } [callback] callback Asynchronous callback interface. | 1310 | + * @param { Callback<boolean> } [callback] - 回调函数,取消指定callback对象的事件响应。需与accessibility.onScreenReaderStateChange的 |
| 1311 | + * callback一致。缺省时,表示注销所有已注册事件。 | ||
| 1308 | * SystemCapability.BarrierFree.Accessibility.Core | 1312 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1309 | * | 1313 | * |
| 1310 | * | 1314 | * |
| @@ -1338,9 +1342,9 @@ declare namespace accessibility { | |||
| 1338 | function on(type: 'touchModeChange', callback: Callback<string>): void; | 1342 | function on(type: 'touchModeChange', callback: Callback<string>): void; |
| 1339 | 1343 | ||
| 1340 | /** | 1344 | /** |
| 1341 | - * Register the observe of the touch mode changed. | 1345 | + * 监听触摸浏览功能下的单击/双击操作模式变化事件。使用callback异步回调。 |
| 1342 | * | 1346 | * |
| 1343 | - * @param { Callback<string> } callback callback Asynchronous callback interface. | 1347 | + * @param { Callback<string> } callback - 回调函数,在触摸浏览功能下的单击/双击操作模式变化时将状态通过此函数进行通知。 |
| 1344 | * SystemCapability.BarrierFree.Accessibility.Core | 1348 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1345 | * | 1349 | * |
| 1346 | * | 1350 | * |
| @@ -1367,9 +1371,10 @@ declare namespace accessibility { | |||
| 1367 | function off(type: 'touchModeChange', callback?: Callback<string>): void; | 1371 | function off(type: 'touchModeChange', callback?: Callback<string>): void; |
| 1368 | 1372 | ||
| 1369 | /** | 1373 | /** |
| 1370 | - * Unregister the observe of the touch mode changed. | 1374 | + * 取消监听触摸浏览功能下的单击/双击操作模式变化事件。使用callback异步回调。 |
| 1371 | * | 1375 | * |
| 1372 | - * @param { Callback<string> } [callback] callback Asynchronous callback interface. | 1376 | + * @param { Callback<string> } [callback] - 回调函数。取消指定callback对象的事件响应。需与accessibility.onTouchModeChange的callback一致。缺省时, |
| 1377 | + * 表示注销所有已注册事件。 | ||
| 1373 | * SystemCapability.BarrierFree.Accessibility.Core | 1378 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1374 | * | 1379 | * |
| 1375 | * | 1380 | * |
| @@ -2523,8 +2528,8 @@ export enum AccessibilityAction { | |||
| 2523 | SET_TEXT = 10, | 2528 | SET_TEXT = 10, |
| 2524 | 2529 | ||
| 2525 | /** | 2530 | /** |
| 2526 | - * 表示向前滚动组件(向内容末尾方向滚动)。需配置参数[Parameter]{@link ./application/AccessibilityExtensionContext:Parameter}.scrollType,参数值为' | 2531 | + * 表示向前滚动组件(向内容末尾方向滚动)。需配置参数[Parameter]{@link ./application/AccessibilityExtensionContext:Parameter}.scrollType,参数值为 |
| 2527 | - * fullScreen'或'halfScreen'。 | 2532 | + * 'fullScreen'或'halfScreen'。 |
| 2528 | * | 2533 | * |
| 2529 | * SystemCapability.BarrierFree.Accessibility.Core | 2534 | * SystemCapability.BarrierFree.Accessibility.Core |
| 2530 | * | 2535 | * |
| @@ -2534,8 +2539,8 @@ export enum AccessibilityAction { | |||
| 2534 | SCROLL_FORWARD = 11, | 2539 | SCROLL_FORWARD = 11, |
| 2535 | 2540 | ||
| 2536 | /** | 2541 | /** |
| 2537 | - * 表示向后滚动组件(向内容起始方向滚动)。需配置参数[Parameter]{@link ./application/AccessibilityExtensionContext:Parameter}.scrollType,参数值为' | 2542 | + * 表示向后滚动组件(向内容起始方向滚动)。需配置参数[Parameter]{@link ./application/AccessibilityExtensionContext:Parameter}.scrollType,参数值为 |
| 2538 | - * fullScreen'或'halfScreen'。 | 2543 | + * 'fullScreen'或'halfScreen'。 |
| 2539 | * | 2544 | * |
| 2540 | * SystemCapability.BarrierFree.Accessibility.Core | 2545 | * SystemCapability.BarrierFree.Accessibility.Core |
| 2541 | * | 2546 | * |
| @@ -118,7 +118,7 @@ export type WindowType = _WindowType; | |||
| 118 | export type Rect = _Rect; | 118 | export type Rect = _Rect; |
| 119 | 119 | ||
| 120 | /** | 120 | /** |
| 121 | - * Indicates executeAction parameter. | 121 | + * 无障碍节点元素执行特定操作时,为操作提供具体设置的参数值,请参考[Parameter]{@link ./application/AccessibilityExtensionContext:Parameter}。 |
| 122 | * | 122 | * |
| 123 | * SystemCapability.BarrierFree.Accessibility.Core | 123 | * SystemCapability.BarrierFree.Accessibility.Core |
| 124 | * | 124 | * |
| @@ -137,7 +137,7 @@ export type Parameter = _Parameter; | |||
| 137 | export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; | 137 | export type AccessibilityExtensionContext = _AccessibilityExtensionContext.default; |
| 138 | 138 | ||
| 139 | /** | 139 | /** |
| 140 | - * Indicates the rule of the search focus. | 140 | + * 表示查找可聚焦节点时,如何判断起始节点及其子节点的聚焦能力,请参考[FocusRule]{@link ./application/AccessibilityExtensionContext:FocusRule}。 |
| 141 | * | 141 | * |
| 142 | * SystemCapability.BarrierFree.Accessibility.Core | 142 | * SystemCapability.BarrierFree.Accessibility.Core |
| 143 | * | 143 | * |
| @@ -146,7 +146,7 @@ export type AccessibilityExtensionContext = _AccessibilityExtensionContext.defau | |||
| 146 | export type FocusRule = _FocusRule; | 146 | export type FocusRule = _FocusRule; |
| 147 | 147 | ||
| 148 | /** | 148 | /** |
| 149 | - * Indicates the condition of the search focus. | 149 | + * 表示查询可聚焦节点方式,请参考[FocusCondition]{@link ./application/AccessibilityExtensionContext:FocusCondition}。 |
| 150 | * | 150 | * |
| 151 | * SystemCapability.BarrierFree.Accessibility.Core | 151 | * SystemCapability.BarrierFree.Accessibility.Core |
| 152 | * | 152 | * |
| @@ -155,7 +155,7 @@ export type FocusRule = _FocusRule; | |||
| 155 | export type FocusCondition = _FocusCondition; | 155 | export type FocusCondition = _FocusCondition; |
| 156 | 156 | ||
| 157 | /** | 157 | /** |
| 158 | - * Indicates focus move result. | 158 | + * 查询无障碍节点返回值类型,请参考[FocusMoveResult]{@link ./application/AccessibilityExtensionContext:FocusMoveResult}。 |
| 159 | * | 159 | * |
| 160 | * SystemCapability.BarrierFree.Accessibility.Core | 160 | * SystemCapability.BarrierFree.Accessibility.Core |
| 161 | * | 161 | * |
| @@ -164,7 +164,7 @@ export type FocusCondition = _FocusCondition; | |||
| 164 | export type FocusMoveResult = _FocusMoveResult; | 164 | export type FocusMoveResult = _FocusMoveResult; |
| 165 | 165 | ||
| 166 | /** | 166 | /** |
| 167 | - * Indicates the accessibility virtual node. | 167 | + * 无障碍虚拟节点,请参考[AccessibilityVirtualNode]{@link ./application/AccessibilityExtensionContext:AccessibilityVirtualNode}。 |
| 168 | * | 168 | * |
| 169 | * SystemCapability.BarrierFree.Accessibility.Core | 169 | * SystemCapability.BarrierFree.Accessibility.Core |
| 170 | * | 170 | * |
| @@ -174,7 +174,7 @@ export type FocusMoveResult = _FocusMoveResult; | |||
| 174 | export type AccessibilityVirtualNode = _AccessibilityVirtualNode; | 174 | export type AccessibilityVirtualNode = _AccessibilityVirtualNode; |
| 175 | 175 | ||
| 176 | /** | 176 | /** |
| 177 | - * The touch position of an accessibility virtual node. | 177 | + * 触摸点击位置,请参考[TouchPosition]{@link ./application/AccessibilityExtensionContext:TouchPosition}。 |
| 178 | * | 178 | * |
| 179 | * SystemCapability.BarrierFree.Accessibility.Core | 179 | * SystemCapability.BarrierFree.Accessibility.Core |
| 180 | * | 180 | * |
| @@ -184,7 +184,8 @@ export type AccessibilityVirtualNode = _AccessibilityVirtualNode; | |||
| 184 | export type TouchPosition = _TouchPosition; | 184 | export type TouchPosition = _TouchPosition; |
| 185 | 185 | ||
| 186 | /** | 186 | /** |
| 187 | - * The accessibility extension context. Used to configure, query information, and inject gestures. | 187 | + * 辅助功能扩展的上下文环境,请参考 |
| 188 | + * [AccessibilityExtensionContext]{ ./application/AccessibilityExtensionContext:AccessibilityExtensionContext}。 | ||
| 188 | * | 189 | * |
| 189 | * SystemCapability.BarrierFree.Accessibility.Core | 190 | * SystemCapability.BarrierFree.Accessibility.Core |
| 190 | * 23 static | 191 | * 23 static |
| @@ -193,7 +194,10 @@ export type TouchPosition = _TouchPosition; | |||
| 193 | export { AccessibilityExtensionContext }; | 194 | export { AccessibilityExtensionContext }; |
| 194 | 195 | ||
| 195 | /** | 196 | /** |
| 196 | - * AccessibilityExtensionAbility基于ExtensionAbility框架,提供辅助功能扩展业务的能力。 | 197 | + * AccessibilityExtensionAbility基于ExtensionAbility框架,提供无障碍扩展业务的能力,包括连接无障碍服务、断开无障碍服务、处理无障碍事件和处理无障碍按键事件等。 |
| 198 | + * | ||
| 199 | + * **生命周期流程:** onAccessibilityConnect(连接回调,用于初始化)→ onAccessibilityEventInfo/onAccessibilityKeyEvent(处理无障碍事件和按键事件)→ | ||
| 200 | + * onAccessibilityDisconnect(断开回调,用于资源回收)。 | ||
| 197 | * | 201 | * |
| 198 | * SystemCapability.BarrierFree.Accessibility.Core | 202 | * SystemCapability.BarrierFree.Accessibility.Core |
| 199 | * 9 dynamic | 203 | * 9 dynamic |
| @@ -14,18 +14,7 @@ | |||
| 14 | */ | 14 | */ |
| 15 | 15 | ||
| 16 | /** | 16 | /** |
| 17 | - * ###### 使用说明 | 17 | + * 辅助功能扩展上下文模块提供上下文环境,支持辅助应用配置关注的信息类型、查询节点信息、手势注入等。 |
| 18 | - * | ||
| 19 | - * 使用AccessibilityExtensionContext功能前,通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContext实例。 | ||
| 20 | - * | ||
| 21 | - * ```ts | ||
| 22 | - * import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit'; | ||
| 23 | - * class EntryAbility extends AccessibilityExtensionAbility { | ||
| 24 | - * onConnect(): void { | ||
| 25 | - * let axContext = this.context; | ||
| 26 | - * } | ||
| 27 | - * } | ||
| 28 | - * ``` | ||
| 29 | * | 18 | * |
| 30 | * 辅助功能扩展上下文 | 19 | * 辅助功能扩展上下文 |
| 31 | * AccessibilityKit | 20 | * AccessibilityKit |
| @@ -47,6 +36,19 @@ import type Want from '../@ohos.app.ability.Want'; | |||
| 47 | * AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境,继承自ExtensionContext。 | 36 | * AccessibilityExtensionContext是AccessibilityExtensionAbility上下文环境,继承自ExtensionContext。 |
| 48 | * | 37 | * |
| 49 | * 辅助功能扩展上下文模块提供辅助功能扩展的相关能力,包括配置关注信息类型、查询节点信息、手势注入等。 | 38 | * 辅助功能扩展上下文模块提供辅助功能扩展的相关能力,包括配置关注信息类型、查询节点信息、手势注入等。 |
| 39 | + * | ||
| 40 | + * ###### 使用说明 | ||
| 41 | + * | ||
| 42 | + * 使用AccessibilityExtensionContext功能前,通过AccessibilityExtensionAbility子类实例获取AccessibilityExtensionContext实例。 | ||
| 43 | + * | ||
| 44 | + * ```ts | ||
| 45 | + * import { AccessibilityExtensionAbility } from '@kit.AccessibilityKit'; | ||
| 46 | + * class EntryAbility extends AccessibilityExtensionAbility { | ||
| 47 | + * onConnect(): void { | ||
| 48 | + * let axContext = this.context; | ||
| 49 | + * } | ||
| 50 | + * } | ||
| 51 | + * ``` | ||
| 50 | * | 52 | * |
| 51 | * SystemCapability.BarrierFree.Accessibility.Core | 53 | * SystemCapability.BarrierFree.Accessibility.Core |
| 52 | * 9 dynamic | 54 | * 9 dynamic |
| @@ -395,10 +397,10 @@ declare class AccessibilityExtensionContext extends ExtensionContext { | |||
| 395 | on(type: 'preDisconnect', callback: Callback<void>): void; | 397 | on(type: 'preDisconnect', callback: Callback<void>): void; |
| 396 | 398 | ||
| 397 | /** | 399 | /** |
| 398 | - * Register accessibilityExtensionAbility disconnect callback. | 400 | + * 向无障碍服务注册回调函数,在无障碍服务关闭该无障碍扩展服务前会执行该回调函数。使用callback异步回调。 |
| 399 | * | 401 | * |
| 400 | * ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY | 402 | * ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY |
| 401 | - * @param { Callback<void> } callback Indicates the callback function. | 403 | + * @param { Callback<void> } callback - 回调函数,在无障碍扩展服务即将关闭时回调。 |
| 402 | * { BusinessError } 201 - Permission verification failed. | 404 | * { BusinessError } 201 - Permission verification failed. |
| 403 | * The application does not have the permission required to call the API. | 405 | * The application does not have the permission required to call the API. |
| 404 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 406 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -426,10 +428,11 @@ declare class AccessibilityExtensionContext extends ExtensionContext { | |||
| 426 | off(type: 'preDisconnect', callback?: Callback<void>): void; | 428 | off(type: 'preDisconnect', callback?: Callback<void>): void; |
| 427 | 429 | ||
| 428 | /** | 430 | /** |
| 429 | - * Unregister accessibilityExtensionAbility disconnect callback. | 431 | + * 取消已经向无障碍服务注册的预关闭回调函数,无障碍服务关闭该扩展服务前不再执行该回调。使用callback异步回调。 |
| 430 | * | 432 | * |
| 431 | * ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY | 433 | * ohos.permission.ACCESSIBILITY_EXTENSION_ABILITY |
| 432 | - * @param { Callback<void> } [callback] Indicates the callback function. | 434 | + * @param { Callback<void> } [callback] - 回调函数,取消指定无障碍扩展服务即将关闭时的回调。需与 |
| 435 | + * [onPreDisconnect]{ AccessibilityExtensionContext#onPreDisconnect}的callback一致。缺省时,表示注销所有已注册事件。 | ||
| 433 | * { BusinessError } 201 - Permission verification failed. | 436 | * { BusinessError } 201 - Permission verification failed. |
| 434 | * The application does not have the permission required to call the API. | 437 | * The application does not have the permission required to call the API. |
| 435 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 438 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| @@ -576,9 +579,8 @@ export default AccessibilityExtensionContext; | |||
| 576 | * 无障碍节点元素,提供查询父/子元素、按内容或焦点方向查找元素、执行无障碍操作等能力,适用于无障碍辅助应用需要与界面节点交互和操作的场景。 | 579 | * 无障碍节点元素,提供查询父/子元素、按内容或焦点方向查找元素、执行无障碍操作等能力,适用于无障碍辅助应用需要与界面节点交互和操作的场景。 |
| 577 | * | 580 | * |
| 578 | * 调用AccessibilityElement的方法前,先通过 | 581 | * 调用AccessibilityElement的方法前,先通过 |
| 579 | - * [AccessibilityExtensionContext.getFocusElement()]{@link AccessibilityExtensionContext#getFocusElement(isAccessibilityFocus?: boolean)} | 582 | + * [AccessibilityExtensionContext.getAccessibilityFocusedElement()]{@link AccessibilityExtensionContext.getAccessibilityFocusedElement} |
| 580 | - * 或 | 583 | + * 或[AccessibilityExtensionContext.getRootInActiveWindow()]{@link AccessibilityExtensionContext.getRootInActiveWindow} |
| 581 | - * [AccessibilityExtensionContext.getWindowRootElement()]{ AccessibilityExtensionContext#getWindowRootElement(windowId?: int)} | ||
| 582 | * 获取AccessibilityElement实例。 | 584 | * 获取AccessibilityElement实例。 |
| 583 | * | 585 | * |
| 584 | * SystemCapability.BarrierFree.Accessibility.Core | 586 | * SystemCapability.BarrierFree.Accessibility.Core |
| @@ -1601,10 +1603,10 @@ export declare interface AccessibilityElement { | |||
| 1601 | findElement(type: 'textType', condition: string): Promise<Array<AccessibilityElement>>; | 1603 | findElement(type: 'textType', condition: string): Promise<Array<AccessibilityElement>>; |
| 1602 | 1604 | ||
| 1603 | /** | 1605 | /** |
| 1604 | - * Find elements that match the condition. | 1606 | + * 根据节点配置的accessibilityTextHint无障碍文本类型查询所有节点元素。使用Promise异步回调。 |
| 1605 | * | 1607 | * |
| 1606 | - * @param { string } condition Indicates the specific content to be queried. | 1608 | + * @param { string } condition - 表示查找的条件。 |
| 1607 | - * @returns { Promise<Array<AccessibilityElement>> } | 1609 | + * @returns { Promise<Array<AccessibilityElement>> } Promise对象,返回满足指定查询关键字的所有节点元素。 |
| 1608 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 1610 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| 1609 | * SystemCapability.BarrierFree.Accessibility.Core | 1611 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1610 | * | 1612 | * |
| @@ -1631,10 +1633,10 @@ export declare interface AccessibilityElement { | |||
| 1631 | findElement(type: 'elementId', condition: long): Promise<AccessibilityElement>; | 1633 | findElement(type: 'elementId', condition: long): Promise<AccessibilityElement>; |
| 1632 | 1634 | ||
| 1633 | /** | 1635 | /** |
| 1634 | - * Find elements that match the condition. | 1636 | + * 根据elementId查询当前活动窗口下的节点元素。使用Promise异步回调。 |
| 1635 | * | 1637 | * |
| 1636 | - * @param { long } condition Indicates the specific content to be queried. | 1638 | + * @param { long } condition - 表示要查询的节点元素的elementId。 |
| 1637 | - * @returns { Promise<AccessibilityElement> } | 1639 | + * @returns { Promise<AccessibilityElement> } Promise对象,返回满足指定查询条件的节点元素。 |
| 1638 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. | 1640 | * { BusinessError } 202 - Permission verification failed. A non-system application calls a system API. |
| 1639 | * SystemCapability.BarrierFree.Accessibility.Core | 1641 | * SystemCapability.BarrierFree.Accessibility.Core |
| 1640 | * | 1642 | * |
| @@ -2341,7 +2343,7 @@ export interface ElementAttributeValues { | |||
| 2341 | */ | 2343 | */ |
| 2342 | customActions?: Array<string>; | 2344 | customActions?: Array<string>; |
| 2343 | /** | 2345 | /** |
| 2344 | - * Indicates the source of this element. | 2346 | + * 组件来源类型,用于区分默认组件和新增、修改的虚拟组件。 |
| 2345 | * | 2347 | * |
| 2346 | * SystemCapability.BarrierFree.Accessibility.Core | 2348 | * SystemCapability.BarrierFree.Accessibility.Core |
| 2347 | * | 2349 | * |
| @@ -2810,8 +2812,8 @@ export declare class Parameter { | |||
| 2810 | */ | 2812 | */ |
| 2811 | spanId?: string; | 2813 | spanId?: string; |
| 2812 | /** | 2814 | /** |
| 2813 | - * 执行[AccessibilityAction]{@link @ohos.accessibility:AccessibilityAction}.SCROLL_FORWARD或SCROLL_BACKWARD时配置,组件滚动类型。' | 2815 | + * 执行[AccessibilityAction]{@link @ohos.accessibility:AccessibilityAction}.SCROLL_FORWARD或SCROLL_BACKWARD时配置,组件滚动类型。 |
| 2814 | - * fullScreen'表示全屏滚动;'halfScreen'表示半屏滚动。 | 2816 | + * 'fullScreen'表示全屏滚动;'halfScreen'表示半屏滚动。 |
| 2815 | * | 2817 | * |
| 2816 | * SystemCapability.BarrierFree.Accessibility.Core | 2818 | * SystemCapability.BarrierFree.Accessibility.Core |
| 2817 | * | 2819 | * |