API Reference

Complete reference for all automation interfaces, methods, and types

The Automation API is accessed through the global agent object. It provides comprehensive control over Android devices including touch gestures, text input, app management, file operations, and screen content access.

Entry Point

TypeScript

// The agent object is globally available in automation scripts
declare const agent: Agent;

interface Agent {
  constants: AgentConstants;    // Accessibility action constants
  actions: AgentActions;        // Device automation methods
  utils: AgentUtils;            // Utility functions & file operations
  info: AgentInfo;              // Device & automation metadata
  control: AgentControl;        // Automation control
  display: AgentDisplay;        // HTML overlay display
  email: AgentEmail;            // Email operations
  notifications: AgentNotifications;  // Notification handling
}

Agent Namespaces

Constants

44 accessibility action constants for nodeAction() operations

Actions

26 methods for device interaction: tap, swipe, screenshot, screenContent, launchApp, and more

Utils & Files

Utility functions and 14 file operation methods

Info

Get automation and device metadata

Control

Stop automation execution

Display

Show HTML overlays on screen

Email

Read emails via IMAP

Notifications

Handle system notifications

Screen Content

AndroidNode

Accessibility tree nodes with 35+ properties and 11 methods for traversing and querying UI elements

AndroidNodeFilter

Builder pattern with 28 chainable methods for finding nodes: isButton(), hasText(), isClickable(), and more

Automation API