chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.accessibility/AccessibilityDomain

AccessibilityDomain

class AccessibilityDomain

(undocumented in the protocol definition)

Official doc

Functions

disable

suspend fun disable(): DisableResponse

Disables the accessibility domain.

enable

suspend fun enable(): EnableResponse

Enables the accessibility domain which causes AXNodeIds to remain consistent between method calls. This turns on accessibility for the page, which can impact performance until accessibility is disabled.

events

fun events(): Flow<AccessibilityEvent>

Subscribes to all events related to this domain.

getAXNodeAndAncestors

@JvmOverloads

inline suspend fun getAXNodeAndAncestors(optionalArgs: GetAXNodeAndAncestorsRequest.Builder.() -> Unit = {}): GetAXNodeAndAncestorsResponse

suspend fun getAXNodeAndAncestors(input: GetAXNodeAndAncestorsRequest): GetAXNodeAndAncestorsResponse

Fetches a node and all ancestors up to and including the root. Requires enable() to have been called previously.

getChildAXNodes

suspend fun getChildAXNodes(input: GetChildAXNodesRequest): GetChildAXNodesResponse

@JvmOverloads

inline suspend fun getChildAXNodes(id: AXNodeId, optionalArgs: GetChildAXNodesRequest.Builder.() -> Unit = {}): GetChildAXNodesResponse

Fetches a particular accessibility node by AXNodeId. Requires enable() to have been called previously.

getFullAXTree

@JvmOverloads

inline suspend fun getFullAXTree(optionalArgs: GetFullAXTreeRequest.Builder.() -> Unit = {}): GetFullAXTreeResponse

suspend fun getFullAXTree(input: GetFullAXTreeRequest): GetFullAXTreeResponse

Fetches the entire accessibility tree for the root Document

getPartialAXTree

@JvmOverloads

inline suspend fun getPartialAXTree(optionalArgs: GetPartialAXTreeRequest.Builder.() -> Unit = {}): GetPartialAXTreeResponse

suspend fun getPartialAXTree(input: GetPartialAXTreeRequest): GetPartialAXTreeResponse

Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.

getRootAXNode

@JvmOverloads

inline suspend fun getRootAXNode(optionalArgs: GetRootAXNodeRequest.Builder.() -> Unit = {}): GetRootAXNodeResponse

suspend fun getRootAXNode(input: GetRootAXNodeRequest): GetRootAXNodeResponse

Fetches the root node. Requires enable() to have been called previously.

loadComplete

fun ~~loadComplete~~(): Flow<AccessibilityEvent.LoadComplete>

loadCompleteEvents

fun loadCompleteEvents(): Flow<AccessibilityEvent.LoadComplete>

The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.

nodesUpdated

fun ~~nodesUpdated~~(): Flow<AccessibilityEvent.NodesUpdated>

nodesUpdatedEvents

fun nodesUpdatedEvents(): Flow<AccessibilityEvent.NodesUpdated>

The nodesUpdated event is sent every time a previously requested node has changed the in tree.

queryAXTree

@JvmOverloads

inline suspend fun queryAXTree(optionalArgs: QueryAXTreeRequest.Builder.() -> Unit = {}): QueryAXTreeResponse

suspend fun queryAXTree(input: QueryAXTreeRequest): QueryAXTreeResponse

Query a DOM node's accessibility subtree for accessible name and role. This command computes the name and role for all nodes in the subtree, including those that are ignored for accessibility, and returns those that match the specified name and role. If no DOM node is specified, or the DOM node does not exist, the command returns an error. If neither accessibleName or role is specified, it returns all the accessibility nodes in the subtree.