AccessibilityApi class

Constructors

AccessibilityApi(Client _client)

Properties

hashCode → int
The hash code for this object.
no setterinherited
onLoadComplete → Stream<AXNodeData>
The loadComplete event mirrors the load complete event sent by the browser to assistive technology when the web page has finished loading.
no setter
onNodesUpdated → Stream<List<AXNodeData>>
The nodesUpdated event is sent every time a previously requested node has changed the in tree.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

disable() → Future<void>
Disables the accessibility domain.
enable() → Future<void>
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.
getAXNodeAndAncestors({NodeId? nodeId, BackendNodeId? backendNodeId, RemoteObjectId? objectId}) → Future<List<AXNodeData>>
Fetches a node and all ancestors up to and including the root. Requires enable() to have been called previously. nodeId Identifier of the node to get. backendNodeId Identifier of the backend node to get. objectId JavaScript object id of the node wrapper to get.
getChildAXNodes(AXNodeId id, {FrameId? frameId}) → Future<List<AXNodeData>>
Fetches a particular accessibility node by AXNodeId. Requires enable() to have been called previously. frameId The frame in whose document the node resides. If omitted, the root frame is used.
getFullAXTree({int? depth, FrameId? frameId}) → Future<List<AXNodeData>>
Fetches the entire accessibility tree for the root Document depth The maximum depth at which descendants of the root node should be retrieved. If omitted, the full tree is returned. frameId The frame for whose document the AX tree should be retrieved. If omitted, the root frame is used.
getPartialAXTree({NodeId? nodeId, BackendNodeId? backendNodeId, RemoteObjectId? objectId, bool? fetchRelatives}) → Future<List<AXNodeData>>
Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists. nodeId Identifier of the node to get the partial accessibility tree for. backendNodeId Identifier of the backend node to get the partial accessibility tree for. objectId JavaScript object id of the node wrapper to get the partial accessibility tree for. fetchRelatives Whether to fetch this node's ancestors, siblings and children. Defaults to true. Returns: The Accessibility.AXNode for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.
getRootAXNode({FrameId? frameId}) → Future<AXNodeData>
Fetches the root node. Requires enable() to have been called previously. frameId The frame in whose document the node resides. If omitted, the root frame is used.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
queryAXTree({NodeId? nodeId, BackendNodeId? backendNodeId, RemoteObjectId? objectId, String? accessibleName, String? role}) → Future<List<AXNodeData>>
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. nodeId Identifier of the node for the root to query. backendNodeId Identifier of the backend node for the root to query. objectId JavaScript object id of the node wrapper for the root to query. accessibleName Find nodes with this computed name. role Find nodes with this computed role. Returns: A list of Accessibility.AXNode matching the specified attributes, including nodes that are ignored for accessibility.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited