Global ObjectNetwork and Integration

Request

Request is used for external service communication.

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

Request 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. Request is used for external service communication.

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. This API becomes most valuable in external integration 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

The most common pattern is to parse Request output with JSON or Regex and then pass it into File or Map objects.

Example Usage

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

lua

local res = Request.get("https://example.com")
toast("HTTP: " .. tostring(res:getResponseCode()))

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

local res = Request.get("https://example.com")
toast("HTTP: " .. tostring(res:getResponseCode()))

Simple

Wraps the base call with minimal flow control.

Simple

lua

local res = Request.get("https://example.com")
toast("HTTP: " .. tostring(res:getResponseCode()))

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow

lua

local res = Request.get("https://example.com")
toast("HTTP: " .. tostring(res:getResponseCode()))
local note = "Request overview loaded"
print(note)

Detailed

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

Detailed

lua

-- 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_request_step()
  local res = Request.get("https://example.com")
  toast("HTTP: " .. tostring(res:getResponseCode()))
end

local ok, err = pcall(run_request_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

local response = Request.get("https://example.com/api/status")
local bodyText = tostring(response:getBody())
local json = JSON.parse(bodyText)
print("Remote status: " .. tostring(json.status))