Macro Handler

Macro Handler

Android Automation Platform

Global ObjectNetwork and IntegrationSingleton Global

WebSocket

WebSocket client: WebSocket.text and WebSocket.exchange make a one-off exchange; WebSocket.connect opens a connection object whose send, receive, on and close methods are called on it.

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

WebSocket is a singleton global table: call its functions with a dot (WebSocket.<method>(...)).

When To Use It

For network integration, use HTTPS only, keep the response size bounded, and validate the response code before moving into JSON or File steps.

Parameters and Return

WebSocket offers 10 methods; each method page lists its parameters and return value.

Options and Limits

Only wss:// addresses are accepted; local and internal network addresses are blocked. WebSocket.connect waits 1-60 seconds (default 15) to connect and raises an error when it cannot.

Best Combined With

The most common pattern is to check a Request response with getResponseCode(), read its body with getData() and parse it with JSON.parse().

Example Usage

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

lua
Try in Editor →
local socket = WebSocket.connect("wss://example.com/socket")
socket:send("ping")
local event = socket:receive(5000)
socket:close()

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 socket = WebSocket.connect("wss://example.com/socket")
socket:send("ping")
local event = socket:receive(5000)
socket:close()

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local socket = WebSocket.connect("wss://example.com/socket")
socket:send("ping")
local event = socket:receive(5000)
socket:close()

-- 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 →
local socket = WebSocket.connect("wss://example.com/socket")
socket:send("ping")
local event = socket:receive(5000)
socket:close()
local note = "WebSocket overview loaded"
print(note)

Detailed

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

Detailed
lua
Try in Editor →
-- For network integration, use HTTPS only, keep the response size bounded, and validate the response code before moving into JSON or File steps.
local function run_websocket_step()
  local socket = WebSocket.connect("wss://example.com/socket")
  socket:send("ping")
  local event = socket:receive(5000)
  socket:close()
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
Try in Editor →
local socket = WebSocket.connect("wss://example.com/socket")
socket:send("ping")
local event = socket:receive(5000)
socket:close()
KV.set("last_network_step", DateTime.now():format("yyyy-MM-dd HH:mm:ss"))
print("Network step finished")