Macro Handler

Macro Handler

Android Automation Platform

Global ObjectData and FilesSingleton Global

KV

Persistent key-value storage private to the macro. Each macro has its own store; a value is limited to 1 MB and the store to 10 MB.

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

KV is a singleton global table: call its functions with a dot (KV.<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

KV offers 14 methods; each method page lists its parameters and return value.

Options and Limits

Limits: 1 MB per value and 10 MB for the whole store (KV.set, KV.append and KV.setAll raise an error past the limit). The store is separated by macro id, so another macro’s KV data cannot be read. Keys must be strings.

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 runs = KV.increment("runs", 1)
KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))

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 runs = KV.increment("runs", 1)
KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local runs = KV.increment("runs", 1)
KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))

-- 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 →
local runs = KV.increment("runs", 1)
KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))
local note = "KV 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_kv_step()
  local runs = KV.increment("runs", 1)
  KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))
end

local ok, err = pcall(run_kv_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 runs = KV.increment("runs", 1)
KV.set("last_run", DateTime.now():format("yyyy-MM-dd HH:mm"))
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)