Macro Handler

Macro Handler

Android Automation Platform

Object MethodTouch and Actions

Ui.byId(id)

Returns the first element with the resource id.

Documented for app version 1.0.51Updated:

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

How To Call It

Ui is a global table: call its functions with a dot (Ui.<method>(...)), not a colon.

When To Use It

In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.

Parameters and Return

Required: id. Returns a Lua table, or nil.

Best Combined With

It works best together with wait(), Point, SwipeParam, ClickParam, and sometimes a Region result.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

lua
Try in Editor →
local result = Ui.byId("com.example:id/start")

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
lua
Try in Editor →
local result = Ui.byId("com.example:id/start")

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = Ui.byId("com.example:id/start")
if stepOk then
  wait(200)
end

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
lua
Try in Editor →
local ok, err = pcall(function()
  local result = Ui.byId("com.example:id/start")
end)

if not ok then
  print("API step failed: Ui.byId: " .. tostring(err))
  requestStop()
end

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
lua
Try in Editor →
-- In automation flow, chain actions with short wait() intervals and use requestStop() or controlled retry on failure paths.
local function run_byid_step()
  local result = Ui.byId("com.example:id/start")
end

local ok, err = pcall(run_byid_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
lua
Try in Editor →
local target = Point(540, 960)
quickTap(target)
wait(250)
local result = Ui.byId("com.example:id/start")
wait(250)
print("Automation chain completed")