Macro Handler

Macro Handler

Android Automation Platform

Object MethodParameter Objects

FindParam.getHighlightDuration()

Returns the highlight time in milliseconds: the default, 2000, on the FindParam table itself, or the value set on a parameter object.

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

FindParam is a global table: call its functions with a dot (FindParam.<method>(...)), not a colon.

When To Use It

Parameter objects work best when prepared in a dedicated variable and reused across search or action calls.

Parameters and Return

Takes no arguments. Returns a number.

Best Combined With

This object is mostly used to prepare input for action APIs such as Region searches, click(), swipe() and Replay playback.

Example Usage

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

lua
Try in Editor →
local result = FindParam.getHighlightDuration()

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 result = FindParam.getHighlightDuration()

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local result = FindParam.getHighlightDuration()
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 result = FindParam.getHighlightDuration()
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- Parameter objects work best when prepared in a dedicated variable and reused across search or action calls.
local function run_gethighlightduration_step()
  local result = FindParam.getHighlightDuration()
end

local ok, err = pcall(run_gethighlightduration_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 result = FindParam.getHighlightDuration()
wait(200)
print("Combined with logging and flow control")