Macro Handler

Macro Handler

Android Automation Platform

Global FunctionCore Flow

requestStop()

Asks the macro to stop gracefully; running waits and gestures end at their next stop check.

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

This is a global function: call it directly, without a table prefix.

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

Takes no arguments. Returns nothing.

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 →
if not License.isActive() then
  requestStop()
end

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 →
if not License.isActive() then
  requestStop()
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
if not License.isActive() then
  requestStop()
end
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()
  if not License.isActive() then
    requestStop()
  end
end)

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

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_requeststop_step()
  if not License.isActive() then
    requestStop()
  end
end

local ok, err = pcall(run_requeststop_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 →
if not License.isActive() then
  requestStop()
end
wait(200)
print("Combined with logging and flow control")