Macro Handler

Macro Handler

Android Automation Platform

Global ObjectData and FilesSingleton Global

Collection

Persistent document collections private to the macro: write with put(name, id, document) and query by field equality with find(name, field, 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

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

When To Use It

In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.

Parameters and Return

Collection offers 10 methods; each method page lists its parameters and return value.

Options and Limits

Limits: collection names up to 64 and document ids up to 128 characters (letters, digits, _, -, .); 64 KiB per document, 5 MiB and 1,000 documents per collection; a query returns at most 100 documents. The store is separated by macro id.

Best Combined With

When combined with Str, JSON, Regex, Array, Map, and File, data transformation becomes much more readable in script flow.

Example Usage

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

lua
Try in Editor →
Collection.put("players", "player_1", { name = "Ada", level = 3 })
local players = Collection.find("players", "level", 3, 10)

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 →
Collection.put("players", "player_1", { name = "Ada", level = 3 })
local players = Collection.find("players", "level", 3, 10)

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
Collection.put("players", "player_1", { name = "Ada", level = 3 })
local players = Collection.find("players", "level", 3, 10)

-- 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 →
Collection.put("players", "player_1", { name = "Ada", level = 3 })
local players = Collection.find("players", "level", 3, 10)
local note = "Collection overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- In data flow, chaining JSON, Regex, Str, Map, and File steps to normalize intermediate values reduces error risk.
local function run_collection_step()
  Collection.put("players", "player_1", { name = "Ada", level = 3 })
  local players = Collection.find("players", "level", 3, 10)
end

local ok, err = pcall(run_collection_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 →
Collection.put("players", "player_1", { name = "Ada", level = 3 })
local players = Collection.find("players", "level", 3, 10)
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)