1# ArkUI_AccessibilityProviderCallbacks 2<!--Kit: ArkUI--> 3<!--Subsystem: ArkUI--> 4<!--Owner: @zhanghangkai10241--> 5<!--Designer: @lmleon--> 6<!--Tester: @fredyuan0912--> 7<!--Adviser: @HelloCrease--> 8 9## 概述 10 11第三方操作provider回调函数结构定义，需要第三方平台实现的相关函数，通过OH_ArkUI_AccessibilityProviderRegisterCallback注册到系统侧。 12 13**起始版本：** 13 14 15**相关模块：** [ArkUI_Accessibility](capi-arkui-accessibility.md) 16 17**所在头文件：** [native_interface_accessibility.h](capi-native-interface-accessibility-h.md) 18 19## 汇总 20 21### 成员函数 22 23| 名称 | 描述 | 24| -- | -- | 25| [int32_t (\*findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode,int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList)](#findaccessibilitynodeinfosbyid) | 由接入方平台实现的回调函数，注册给系统侧调用。查询指定节点的节点信息。支持多实例场景。 | 26| [int32_t (\*findAccessibilityNodeInfosByText)(int64_t elementId, const char* text, int32_t requestId,ArkUI_AccessibilityElementInfoList* elementList)](#findaccessibilitynodeinfosbytext) | 由接入方平台实现的回调函数，注册给系统侧调用。基于指定的节点，查询满足指定text内容的节点信息。 | 27| [int32_t (\*findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType,int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo)](#findfocusedaccessibilitynode) | 当需要基于指定节点获取焦点元素信息时调用。 | 28| [int32_t (\*findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction,int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo)](#findnextfocusaccessibilitynode) | 根据参考节点查询可以聚焦的节点，根据模式和方向查询下一个可以聚焦的节点。 | 29| [int32_t (\*executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action,ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId)](#executeaccessibilityaction) | 在指定节点上执行Action操作。 | 30| [int32_t (\*clearFocusedFocusAccessibilityNode)()](#clearfocusedfocusaccessibilitynode) | 清除当前焦点节点的焦点状态。 | 31| [int32_t (\*getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t* index)](#getaccessibilitynodecursorposition) | 查询指定节点的当前光标位置。 | 32 33## 成员函数说明 34 35### findAccessibilityNodeInfosById() 36 37``` 38int32_t (*findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode,int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList) 39``` 40 41**描述：** 42 43 44由接入方平台实现的回调函数，注册给系统侧调用。查询指定节点的节点信息。支持多实例场景。 45 46**起始版本：** 13 47 48**参数：** 49 50| 参数项 | 描述 | 51|--------------------------------------------------------------------------------| -- | 52| int64_t elementId | 无障碍元素的唯一编号。 | 53| [ArkUI_AccessibilitySearchMode](capi-native-interface-accessibility-h.md) mode | 表示无障碍搜索模式。 | 54| int32_t requestId | 表示请求ID。 | 55| [ArkUI_AccessibilityElementInfoList](capi-arkui-accessibility-arkui-accessibilityelementinfolist.md)* elementList | 表示无障碍元素信息列表。 | 56 57**返回：** 58 59| 类型 | 说明 | 60| -- | -- | 61| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 62 63### findAccessibilityNodeInfosByText() 64 65``` 66int32_t (*findAccessibilityNodeInfosByText)(int64_t elementId, const char* text, int32_t requestId,ArkUI_AccessibilityElementInfoList* elementList) 67``` 68 69**描述：** 70 71由接入方平台实现的回调函数，注册给系统侧调用。基于指定的节点，查询满足指定text内容的节点信息。 72 73**起始版本：** 13 74 75**参数：** 76 77| 参数项 | 描述 | 78| -- | -- | 79| int64_t elementId | 无障碍元素的唯一编号。 | 80| const char* text | 表示无障碍文本。 | 81| int32_t requestId | 表示请求ID。 | 82| [ArkUI_AccessibilityElementInfoList](capi-arkui-accessibility-arkui-accessibilityelementinfolist.md)* elementList | 表示无障碍元素信息列表。 | 83 84**返回：** 85 86| 类型 | 说明 | 87| -- | -- | 88| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 89 90### findFocusedAccessibilityNode() 91 92``` 93int32_t (*findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType,int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo) 94``` 95 96**描述：** 97 98当需要基于指定节点获取焦点元素信息时调用。 99 100**起始版本：** 13 101 102**参数：** 103 104| 参数项 | 描述 | 105|-----------------------------------------------------------------------------------------------------------------| -- | 106| int64_t elementId | 无障碍元素的唯一编号。 | 107| [ArkUI_AccessibilityFocusType](capi-native-interface-accessibility-h.md#arkui_accessibilityfocustype) focusType | 表示焦点的类型。 | 108| int32_t requestId | 表示请求ID。 | 109| [ArkUI_AccessibilityElementInfo](capi-arkui-accessibility-arkui-accessibilityelementinfo.md)* elementInfo | 表示无障碍元素信息。 | 110 111**返回：** 112 113| 类型 | 说明 | 114| -- | -- | 115| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 116 117### findNextFocusAccessibilityNode() 118 119``` 120int32_t (*findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction,int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo) 121``` 122 123**描述：** 124 125根据参考节点查询可以聚焦的节点，根据模式和方向查询下一个可以聚焦的节点。 126 127**起始版本：** 13 128 129**参数：** 130 131| 参数项 | 描述 | 132|-----------------------------------------------------------------------------------------------------------------------------------| -- | 133| int64_t elementId | 无障碍元素的唯一编号。 | 134| [ArkUI_AccessibilityFocusMoveDirection](capi-native-interface-accessibility-h.md#arkui_accessibilityfocusmovedirection) direction | 表示查找方向。 | 135| int32_t requestId | 表示请求ID。 | 136| [ArkUI_AccessibilityElementInfo](capi-arkui-accessibility-arkui-accessibilityelementinfo.md)* elementInfo | 表示无障碍元素信息。 | 137 138**返回：** 139 140| 类型 | 说明 | 141| -- | -- | 142| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 143 144### executeAccessibilityAction() 145 146``` 147int32_t (*executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action,ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId) 148``` 149 150**描述：** 151 152在指定节点上执行Action操作。 153 154**起始版本：** 13 155 156**参数：** 157 158| 参数项 | 描述 | 159|------------------------------------------------------------------------------------------------------------------| -- | 160| int64_t elementId | 无障碍元素的唯一编号。 | 161| [ArkUI_Accessibility_ActionType](capi-native-interface-accessibility-h.md#arkui_accessibility_actiontype) action | 表示要执行的动作。 | 162| [ArkUI_AccessibilityActionArguments](capi-arkui-accessibility-arkui-accessibilityactionarguments.md) *actionArguments | 表示动作的参数。 | 163| int32_t requestId | 表示请求的ID。 | 164 165**返回：** 166 167| 类型 | 说明 | 168| -- | -- | 169| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 170 171### clearFocusedFocusAccessibilityNode() 172 173``` 174int32_t (*clearFocusedFocusAccessibilityNode)() 175``` 176 177**描述：** 178 179清除当前焦点节点的焦点状态。 180 181**起始版本：** 13 182 183**返回：** 184 185| 类型 | 说明 | 186| -- | -- | 187| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 188 189### getAccessibilityNodeCursorPosition() 190 191``` 192int32_t (*getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t* index) 193``` 194 195**描述：** 196 197查询指定节点的当前光标位置。 198 199**起始版本：** 13 200 201**参数：** 202 203| 参数项 | 描述 | 204| -- | -- | 205| int64_t elementId | 无障碍元素的唯一编号。 | 206| int32_t requestId | 表示请求的ID。 | 207| int32_t* index | 表示光标位置的索引。 | 208 209**返回：** 210 211| 类型 | 说明 | 212| -- | -- | 213| int32_t | 如果操作成功，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。<br>如果参数错误，则返回[ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER](capi-native-interface-accessibility-h.md#arkui_acessbilityerrorcode)。 | 214 215 216