Macro Handler

Macro Handler

Android Automation Platform

Object MethodCore Flow

Workflow.each(items, action, options?)

Processes a snapshot of a dense array in order, passing each value and index to the callback.

Documented for app version 1.0.50Updated:

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

Workflow is a global table: call its functions with a dot (Workflow.<method>(...)), not a colon. Requires Macro Handler 1.0.51 or later.

When To Use It

Processes a snapshot of a dense array in order, passing each value and index to the callback.

Parameters and Return

items is a dense 1-based array; use action(value, index), intervalMs and timeoutMs. Order and item references are copied at entry; nested tables are not deep-copied. False breaks early and nil continues. The result has ok, reason, attempts, elapsedMs, value, values and error; values.n preserves the number of multiple returns, including nil. The default timeout is 30000 ms, with a maximum of 86400000 ms and up to 1000000 iterations. Calls are synchronous and cooperative; a blocking operation must still use its own timeout.

Best Combined With

Combine API calls, conditions and reusable Module functions. Stop, pause and execution budgets remain active. Retry actions must be safe to repeat; do not automatically repeat side effects such as payments or taps after an ambiguous network response.

Example Usage

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

lua
Try in Editor →
local result = Workflow.each({"scan", "report", "finish"}, function(value, index)
  print(index, value)
end, {intervalMs = 50, timeoutMs = 2000})
print(result.ok, result.reason)

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 = Workflow.each({"scan", "report", "finish"}, function(value, index)
  print(index, value)
end, {intervalMs = 50, timeoutMs = 2000})
print(result.ok, result.reason)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = Workflow.each({"scan", "report", "finish"}, function(value, index)
  print(index, value)
end, {intervalMs = 50, timeoutMs = 2000})
print(result.ok, result.reason)
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 = Workflow.each({"scan", "report", "finish"}, function(value, index)
    print(index, value)
  end, {intervalMs = 50, timeoutMs = 2000})
  print(result.ok, result.reason)
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- Workflow.each(items, action, options?)
local function run_each_step()
  local result = Workflow.each({"scan", "report", "finish"}, function(value, index)
    print(index, value)
  end, {intervalMs = 50, timeoutMs = 2000})
  print(result.ok, result.reason)
end

local ok, err = pcall(run_each_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 result = Workflow.each({"scan", "report", "finish"}, function(value, index)
  print(index, value)
end, {intervalMs = 50, timeoutMs = 2000})
print(result.ok, result.reason)