Macro Handler

Macro Handler

Android Automation Platform

Object MethodData and Files

Collection.find(name, field, value, limit?)

Returns the documents whose field equals value (at most limit, never more than 100).

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 global table: call its functions with a dot (Collection.<method>(...)), not a colon.

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

Required: name, field, value. Optional: limit (omit to pass nil and use the runtime default). Returns a Lua table.

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 →
local players = Collection.find("players", "level", 3, 10)
for _, player in ipairs(players) do
  print(player.name)
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 players = Collection.find("players", "level", 3, 10)
for _, player in ipairs(players) do
  print(player.name)
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local players = Collection.find("players", "level", 3, 10)
for _, player in ipairs(players) do
  print(player.name)
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 players = Collection.find("players", "level", 3, 10)
  for _, player in ipairs(players) do
    print(player.name)
  end
end)

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

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_find_step()
  local players = Collection.find("players", "level", 3, 10)
  for _, player in ipairs(players) do
    print(player.name)
  end
end

local ok, err = pcall(run_find_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 players = Collection.find("players", "level", 3, 10)
for _, player in ipairs(players) do
  print(player.name)
end
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)