Macro Handler

Macro Handler

Android Automation Platform

Global ObjectOtherSingleton Global

WebSocket

WebSocket is part of the Macro Handler API surface. It is exposed as a singleton global namespace.

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

WebSocket is the main entry point for this object family. Use it to understand the responsibility of the namespace before diving into the methods below it. WebSocket is part of the Macro Handler API surface. It is exposed as a singleton global namespace.

When To Use It

This API is safest when used inside small, readable, and tightly controlled macro steps. This API becomes most valuable in multi-step chained scenarios.

Parameters and Return

This entry does not require mandatory parameters. This entry is a namespace or helper object overview; the real flow is built with the methods listed below it.

Best Combined With

Using this API with logging, error handling, and next-step control produces much more professional results than calling it in isolation.

Example Usage

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

lua
-- WebSocket:exchange
local result = WebSocket:exchange("value")
-- 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
-- WebSocket:exchange
local result = WebSocket:exchange("value")
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple
lua
-- WebSocket:exchange
local result = WebSocket:exchange("value")
-- Use the result in your script flow

-- Continue with one focused method on the object.

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
lua
-- WebSocket:exchange
local result = WebSocket:exchange("value")
-- Use the result in your script flow
local note = "WebSocket overview loaded"
print(note)

Detailed

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

Detailed
lua
-- This API is safest when used inside small, readable, and tightly controlled macro steps.
local function run_websocket_step()
  -- WebSocket:exchange
  local result = WebSocket:exchange("value")
  -- Use the result in your script flow
end

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