Macro Handler

Macro Handler

Android Automation Platform

Object MethodParameter Objects

FindParam:getHighlight()

Reads and returns the related value from FindParam.

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

What It Does

FindParam:getHighlight performs one focused job in script flow and can be chained cleanly with other API steps. Reads and returns the related value from FindParam.

When To Use It

Parameter objects work best when prepared in a dedicated variable and reused across search or action calls. This API becomes most valuable in multi-step chained scenarios.

Parameters and Return

This entry does not require mandatory parameters. This API reads or produces data; storing the returned value in a variable and reusing it in later steps is the safest approach.

Best Combined With

This object is mostly used to prepare input for action APIs such as Region, Touch, or Request.

Example Usage

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

lua
Try in Editor →
-- FindParam:getHighlight
local result = FindParam:getHighlight()
-- Use the result in your script flow

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 →
-- FindParam:getHighlight
local result = FindParam:getHighlight()
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
-- FindParam:getHighlight
local result = FindParam:getHighlight()
-- Use the result in your script flow
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, result = pcall(function()
  -- FindParam:getHighlight
  local result = FindParam:getHighlight()
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: FindParam:getHighlight")
  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_gethighlight_step()
  -- FindParam:getHighlight
  local result = FindParam:getHighlight()
  -- Use the result in your script flow
end

local ok, err = pcall(run_gethighlight_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 →
-- FindParam:getHighlight
local result = FindParam:getHighlight()
-- Use the result in your script flow
wait(200)
print("Combined with logging and flow control")