Macro Handler

Macro Handler

Android Automation Platform

Object MethodCore Flow

AsyncPromise:await(timeoutMs?)

Waits for the promise and returns a success flag and the value.

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 an object method: call it with a colon on a promise created with Async.promise() (nil when the promise limit is reached) (promise:<method>(...)). AsyncPromise is not a global name; the method exists only on that object.

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

Optional: timeoutMs (omit to pass nil and use the runtime default). Returns two values: a success flag (boolean) and the resulting 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 promise = Async.promise()
if promise then
  local ok, value = promise:await()
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 →
local promise = Async.promise()
if promise then
  local ok, value = promise:await()
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local promise = Async.promise()
if promise then
  local ok, value = promise:await()
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()
  local promise = Async.promise()
  if promise then
    local ok, value = promise:await()
  end
end)

if not ok then
  print("API step failed: AsyncPromise:await: " .. 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_await_step()
  local promise = Async.promise()
  if promise then
    local ok, value = promise:await()
  end
end

local ok, err = pcall(run_await_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 promise = Async.promise()
if promise then
  local ok, value = promise:await()
end
wait(200)
print("Combined with logging and flow control")