Package-level declarations

Types

Link copied to clipboard

(undocumented in the protocol definition)

Link copied to clipboard
@Serializable
data class AXNode(val nodeId: AXNodeId, val ignored: Boolean, val ignoredReasons: List<AXProperty>? = null, val role: AXValue? = null, val chromeRole: AXValue? = null, val name: AXValue? = null, val description: AXValue? = null, val value: AXValue? = null, val properties: List<AXProperty>? = null, val parentId: AXNodeId? = null, val childIds: List<AXNodeId>? = null, val backendDOMNodeId: BackendNodeId? = null, val frameId: FrameId? = null)

A node in the accessibility tree.

Link copied to clipboard
typealias AXNodeId = String

Unique accessibility node identifier.

Link copied to clipboard
@Serializable
data class AXProperty(val name: AXPropertyName, val value: AXValue)

(undocumented in the protocol definition)

Link copied to clipboard
@Serializable
enum AXPropertyName : Enum<AXPropertyName>

Values of AXProperty name:

Link copied to clipboard
@Serializable
data class AXRelatedNode(val backendDOMNodeId: BackendNodeId, val idref: String? = null, val text: String? = null)

(undocumented in the protocol definition)

Link copied to clipboard
@Serializable
data class AXValue(val type: AXValueType, val value: JsonElement? = null, val relatedNodes: List<AXRelatedNode>? = null, val sources: List<AXValueSource>? = null)

A single computed AX property.

Link copied to clipboard

Enum of possible native property sources (as a subtype of a particular AXValueSourceType).

Link copied to clipboard
@Serializable
data class AXValueSource(val type: AXValueSourceType, val value: AXValue? = null, val attribute: String? = null, val attributeValue: AXValue? = null, val superseded: Boolean? = null, val nativeSource: AXValueNativeSourceType? = null, val nativeSourceValue: AXValue? = null, val invalid: Boolean? = null, val invalidReason: String? = null)

A single source for a computed AX property.

Link copied to clipboard

Enum of possible property sources.

Link copied to clipboard
@Serializable
enum AXValueType : Enum<AXValueType>

Enum of possible property types.

Link copied to clipboard
@Serializable
object DisableResponse

A dummy response object for the AccessibilityDomain.disable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
object EnableResponse

A dummy response object for the AccessibilityDomain.enable command. This command doesn't return any result at the moment, but this could happen in the future, or could have happened in the past. For forwards and backwards compatibility of the command method, we still declare this class even without properties.

Link copied to clipboard
@Serializable
data class GetAXNodeAndAncestorsRequest(val nodeId: NodeId? = null, val backendNodeId: BackendNodeId? = null, val objectId: RemoteObjectId? = null)

Request object containing input parameters for the AccessibilityDomain.getAXNodeAndAncestors command.

Link copied to clipboard
@Serializable
data class GetAXNodeAndAncestorsResponse(val nodes: List<AXNode>)

Response type for the AccessibilityDomain.getAXNodeAndAncestors command.

Link copied to clipboard
@Serializable
data class GetChildAXNodesRequest(val id: AXNodeId, val frameId: FrameId? = null)

Request object containing input parameters for the AccessibilityDomain.getChildAXNodes command.

Link copied to clipboard
@Serializable
data class GetChildAXNodesResponse(val nodes: List<AXNode>)

Response type for the AccessibilityDomain.getChildAXNodes command.

Link copied to clipboard
@Serializable
data class GetFullAXTreeRequest(val depth: Int? = null, val frameId: FrameId? = null)

Request object containing input parameters for the AccessibilityDomain.getFullAXTree command.

Link copied to clipboard
@Serializable
data class GetFullAXTreeResponse(val nodes: List<AXNode>)

Response type for the AccessibilityDomain.getFullAXTree command.

Link copied to clipboard
@Serializable
data class GetPartialAXTreeRequest(val nodeId: NodeId? = null, val backendNodeId: BackendNodeId? = null, val objectId: RemoteObjectId? = null, val fetchRelatives: Boolean? = null)

Request object containing input parameters for the AccessibilityDomain.getPartialAXTree command.

Link copied to clipboard
@Serializable
data class GetPartialAXTreeResponse(val nodes: List<AXNode>)

Response type for the AccessibilityDomain.getPartialAXTree command.

Link copied to clipboard
@Serializable
data class GetRootAXNodeRequest(val frameId: FrameId? = null)

Request object containing input parameters for the AccessibilityDomain.getRootAXNode command.

Link copied to clipboard
@Serializable
data class GetRootAXNodeResponse(val node: AXNode)

Response type for the AccessibilityDomain.getRootAXNode command.

Link copied to clipboard
@Serializable
data class QueryAXTreeRequest(val nodeId: NodeId? = null, val backendNodeId: BackendNodeId? = null, val objectId: RemoteObjectId? = null, val accessibleName: String? = null, val role: String? = null)

Request object containing input parameters for the AccessibilityDomain.queryAXTree command.

Link copied to clipboard
@Serializable
data class QueryAXTreeResponse(val nodes: List<AXNode>)

Response type for the AccessibilityDomain.queryAXTree command.