Macro Handler

Macro Handler

Android Automation Platform

Object MethodNetwork and Integration

WebSocket.connect(url, timeoutMs?, headers?)

Opens a WebSocket connection and returns a connection object with send, receive, on, once, off, close and isOpen; raises an error when it cannot connect. The timeout is 1-60 seconds (default 15).

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 global table: call its functions with a dot (WebSocket.<method>(...)), not a colon.

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

Required: url. Optional: timeoutMs, headers (omit to pass nil and use the runtime default). Returns a WebSocket object.

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", 10000)
socket:send("ping")
local event = socket:receive(5000)
if event then print(event.type) end
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", 10000)
socket:send("ping")
local event = socket:receive(5000)
if event then print(event.type) end
socket:close()

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local socket = WebSocket.connect("wss://example.com/socket", 10000)
socket:send("ping")
local event = socket:receive(5000)
if event then print(event.type) end
socket:close()
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 socket = WebSocket.connect("wss://example.com/socket", 10000)
  socket:send("ping")
  local event = socket:receive(5000)
  if event then print(event.type) end
  socket:close()
end)

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

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_connect_step()
  local socket = WebSocket.connect("wss://example.com/socket", 10000)
  socket:send("ping")
  local event = socket:receive(5000)
  if event then print(event.type) end
  socket:close()
end

local ok, err = pcall(run_connect_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", 10000)
socket:send("ping")
local event = socket:receive(5000)
if event then print(event.type) end
socket:close()
KV.set("last_network_step", DateTime.now():format("yyyy-MM-dd HH:mm:ss"))
print("Network step finished")