Object MethodNetwork and Integration

Request:setParameter(value)

Updates a configuration or state on Request.

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:setParameter performs one focused job in script flow and can be chained cleanly with other API steps. Updates a configuration or state on Request.

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

value define the purpose of the call; preparing them in clearly named variables before execution makes production debugging easier. This API is primarily side-effect driven; the important result is the device state change rather than the raw return value.

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

-- Request:setParameter
local result = Request:setParameter("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

-- Request:setParameter
local result = Request:setParameter("value")
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- Request:setParameter
local result = Request:setParameter("value")
-- 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

local ok, result = pcall(function()
  -- Request:setParameter
  local result = Request:setParameter("value")
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: Request:setParameter")
  requestStop()
end

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_setparameter_step()
  -- Request:setParameter
  local result = Request:setParameter("value")
  -- Use the result in your script flow
end

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