Macro Handler

Macro Handler

Android Automation Platform

Global ObjectCore FlowSingleton Global

Macro

Runs other macros: Macro.run(target, params) queues one, Macro.runWait(target, params, timeoutMs) waits for it and returns the outcome. Call with a dot.

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

Macro is a singleton global table: call its functions with a dot (Macro.<method>(...)).

When To Use It

Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.

Parameters and Return

Macro offers 4 methods; each method page lists its parameters and return value.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

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

lua
Try in Editor →
local outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
print(outcome.status)

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 outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
print(outcome.status)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
print(outcome.status)

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
lua
Try in Editor →
local outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
print(outcome.status)
local note = "Macro overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- Core flow APIs are usually the backbone of larger scenarios; keep them anchored to clear checkpoints and readable variables.
local function run_macro_step()
  local outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
  print(outcome.status)
end

local ok, err = pcall(run_macro_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 outcome = Macro.runWait("daily_rewards", { level = 3 }, 60000)
print(outcome.status)
wait(200)
print("Combined with logging and flow control")