Macro Handler

Macro Handler

Android Automation Platform

Object MethodCore Flow

Workflow.withCleanup(action, cleanup)

Runs cleanup once after normal completion or an ordinary action error, reporting both outcomes.

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

Runs cleanup once after normal completion or an ordinary action error, reporting both outcomes.

Parameters and Return

Requires action() and cleanup(executed, values, error). Returns ok, reason, value, values, error, cleanupError, attempts and elapsedMs. Additional user cleanup is not guaranteed after a forced user stop or host budget abort.

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.withCleanup(function()
  return "work result"
end, function(executed, values, err)
  print("Cleanup", executed, values[1], err)
end)
print(result.ok, result.reason, result.cleanupError)

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.withCleanup(function()
  return "work result"
end, function(executed, values, err)
  print("Cleanup", executed, values[1], err)
end)
print(result.ok, result.reason, result.cleanupError)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = Workflow.withCleanup(function()
  return "work result"
end, function(executed, values, err)
  print("Cleanup", executed, values[1], err)
end)
print(result.ok, result.reason, result.cleanupError)
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.withCleanup(function()
    return "work result"
  end, function(executed, values, err)
    print("Cleanup", executed, values[1], err)
  end)
  print(result.ok, result.reason, result.cleanupError)
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- Workflow.withCleanup(action, cleanup)
local function run_withcleanup_step()
  local result = Workflow.withCleanup(function()
    return "work result"
  end, function(executed, values, err)
    print("Cleanup", executed, values[1], err)
  end)
  print(result.ok, result.reason, result.cleanupError)
end

local ok, err = pcall(run_withcleanup_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.withCleanup(function()
  return "work result"
end, function(executed, values, err)
  print("Cleanup", executed, values[1], err)
end)
print(result.ok, result.reason, result.cleanupError)