ArkUI_AccessibilityProviderCallbacks

typedef struct {...} ArkUI_AccessibilityProviderCallbacks

Overview

Defines a callback function struct of a third-party operation provider. The functions that need to be implemented by the third-party platform are registered with the system through OH_ArkUI_AccessibilityProviderRegisterCallback.

Since: 13

Related module: ArkUI_Accessibility

Header file: native_interface_accessibility.h

Summary

Member Functions

Name	Description
int32_t (findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode, int32_t requestId, ArkUI_AccessibilityElementInfoList elementList)	Finds node information for the specified node. Callback function implemented by the third-party platform and registered with the system.
int32_t (findAccessibilityNodeInfosByText)(int64_t elementId, const char text, int32_t requestId,ArkUI_AccessibilityElementInfoList* elementList)	Finds the nodes that contain specific text content. Callback function implemented by the third-party platform and registered with the system.
int32_t (findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo elementInfo)	Finds the node that has obtained the focus based on the focus type and returns the element information of the node. Callback function implemented by the third-party platform and registered with the system.
int32_t (findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo elementInfo)	Called to find the next focusable node based on the reference node, in the specified mode and direction.
int32_t (executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action,ArkUI_AccessibilityActionArguments actionArguments, int32_t requestId)	Called to execute a specified action on a specified node.
int32_t (*clearFocusedFocusAccessibilityNode)()	Called to clear the focus state of the current focused node.
int32_t (getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t index)	Called to query the current cursor position of the specified node.

Member Function Description

findAccessibilityNodeInfosById()

int32_t (*findAccessibilityNodeInfosById)(int64_t elementId, ArkUI_AccessibilitySearchMode mode,int32_t requestId, ArkUI_AccessibilityElementInfoList* elementList)

Description

Finds node information for the specified node. Callback function implemented by the third-party platform and registered with the system.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
ArkUI_AccessibilitySearchMode mode	Accessibility search mode.
int32_t requestId	Request ID.
ArkUI_AccessibilityElementInfoList* elementList	Accessibility element information list.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

findAccessibilityNodeInfosByText()

int32_t (*findAccessibilityNodeInfosByText)(int64_t elementId, const char* text, int32_t requestId,ArkUI_AccessibilityElementInfoList* elementList)

Description

Finds the nodes that contain specific text content. Callback function implemented by the third-party platform and registered with the system.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
const char* text	Accessibility text.
int32_t requestId	Request ID.
ArkUI_AccessibilityElementInfoList* elementList	Accessibility element information list.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

findFocusedAccessibilityNode()

int32_t (*findFocusedAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusType focusType, int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo)

Description

Finds the node that has obtained the focus based on the focus type and returns the element information of the node. Callback function implemented by the third-party platform and registered with the system.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
ArkUI_AccessibilityFocusType focusType	Focus type.
int32_t requestId	Request ID.
ArkUI_AccessibilityElementInfo* elementInfo	Accessibility element information.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

findNextFocusAccessibilityNode()

int32_t (*findNextFocusAccessibilityNode)(int64_t elementId, ArkUI_AccessibilityFocusMoveDirection direction, int32_t requestId, ArkUI_AccessibilityElementInfo* elementInfo)

Description

Called to find the next focusable node based on the reference node mode and search direction.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
ArkUI_AccessibilityFocusMoveDirection direction	Search direction.
int32_t requestId	Request ID.
ArkUI_AccessibilityElementInfo* elementInfo	Information about the found accessibility element.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

executeAccessibilityAction()

int32_t (*executeAccessibilityAction)(int64_t elementId, ArkUI_Accessibility_ActionType action,ArkUI_AccessibilityActionArguments *actionArguments, int32_t requestId)

Description

Executes an accessibility action on the specified accessibility node.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
ArkUI_Accessibility_ActionType action	Action to execute.
ArkUI_AccessibilityActionArguments *actionArguments	Action parameters.
int32_t requestId	Request ID.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

clearFocusedFocusAccessibilityNode()

int32_t (*clearFocusedFocusAccessibilityNode)()

Description

Called to clear the focus state of the current focused node.

Since: 13

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.

getAccessibilityNodeCursorPosition()

int32_t (*getAccessibilityNodeCursorPosition)(int64_t elementId, int32_t requestId, int32_t* index)

Description

Called to query the current cursor position of the specified node.

Since: 13

Parameters

Name	Description
int64_t elementId	Unique ID of the accessibility element.
int32_t requestId	Request ID.
int32_t* index	Index of the cursor position.

Returns

Type	Description
int32_t	Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_SUCCESSFUL if the operation is successful. Returns ARKUI_ACCESSIBILITY_NATIVE_RESULT_BAD_PARAMETER if a parameter error occurs.