Macro Handler

Macro Handler

Android Automation Platform

Global ObjectData and FilesSingleton Global

File

Reads, writes and lists text files in the macro’s file area.

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

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

File offers 16 methods; each method page lists its parameters and return value.

Options and Limits

Limits: writes and deletes stay inside this macro’s own folder; at most 10 MB per read or write; paths are at most 4,096 characters and symbolic links are not followed. File calls are limited to 60 per second.

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 →
File.write("run.log", "Started")
local text = File.read("run.log")

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 →
File.write("run.log", "Started")
local text = File.read("run.log")

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
File.write("run.log", "Started")
local text = File.read("run.log")

-- 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 →
File.write("run.log", "Started")
local text = File.read("run.log")
local note = "File 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_file_step()
  File.write("run.log", "Started")
  local text = File.read("run.log")
end

local ok, err = pcall(run_file_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 →
File.write("run.log", "Started")
local text = File.read("run.log")
local raw = File.read("macro.log")
local normalized = Str.trim(raw)
print(normalized)