Macro Handler

Macro Handler

Android Automation Platform

Object MethodSystem ControlComing soonv1.0.52

System.clipboardHistory()

Lists saved clipboard metadata without text: id, position and chars, newest first.

Documented for app version 1.0.52 (not on Google Play yet)Updated:

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

System is a global table: call its functions with a dot (System.<method>(...)), not a colon. Requires Macro Handler 1.0.52 or later.

When To Use It

In system flow, design steps as observe first and act second when the API can affect device state.

Parameters and Return

Takes no arguments. Returns a 1-based Lua array of rows with id (stable UUID), position (current ordering; newest is 1) and chars (UTF-16 length). It returns neither text nor previews. An empty table can mean empty history, denied consent or unreadable storage; it is not proof of permission/readiness.

Options and Limits

All five APIs use the existing clipboard-read consent and macro STOP checks. Saved history contains only explicitly captured entries: at most 32, each up to 4096 UTF-16 code units, encrypted on this device outside backup. Android or keyboard history is not read. Deletion, eviction or key loss never selects other text as a fallback.

Best Combined With

Keep id, not position, when selecting an entry. A new capture changes positions; never fall back from a missing ID to the first row or current clipboard.

Example Usage

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

lua
Try in Editor →
local entries = System.clipboardHistory()
for _, entry in ipairs(entries) do
  print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
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 entries = System.clipboardHistory()
for _, entry in ipairs(entries) do
  print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
end

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local entries = System.clipboardHistory()
for _, entry in ipairs(entries) do
  print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
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 entries = System.clipboardHistory()
  for _, entry in ipairs(entries) do
    print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
  end
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- In system flow, design steps as observe first and act second when the API can affect device state.
local function run_clipboardhistory_step()
  local entries = System.clipboardHistory()
  for _, entry in ipairs(entries) do
    print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
  end
end

local ok, err = pcall(run_clipboardhistory_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 entries = System.clipboardHistory()
for _, entry in ipairs(entries) do
  print("saved position: " .. entry.position .. ", chars: " .. entry.chars)
end