Global ObjectSystem ControlFactory Global

Version(text)

Version comparison. Version.isAtLeast("1.0.40") checks the running app; Version("1.2.3") creates a Version object.

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

Version is a callable factory table: object methods are called as version:<method>(...), and the table’s own functions as Version.<method>(...).

When To Use It

In system flow, design steps as observe first and act second when the API can affect device state.

Parameters and Return

Version offers 16 methods; each method page lists its parameters and return value.

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.

if not Version.isAtLeast("1.0.40") then
  System.alert("Please update Macro Handler")
  requestStop()
end

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
if not Version.isAtLeast("1.0.40") then
  System.alert("Please update Macro Handler")
  requestStop()
end

Simple

Wraps the base call with minimal flow control.

Simple
if not Version.isAtLeast("1.0.40") then
  System.alert("Please update Macro Handler")
  requestStop()
end

-- Continue with one focused method on the object.

Practical Flow

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

Practical Flow
if not Version.isAtLeast("1.0.40") then
  System.alert("Please update Macro Handler")
  requestStop()
end
local note = "Version overview loaded"
print(note)

Detailed

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

Detailed
-- In system flow, design steps as observe first and act second when the API can affect device state.
local function run_version_step()
  if not Version.isAtLeast("1.0.40") then
    System.alert("Please update Macro Handler")
    requestStop()
  end
end

local ok, err = pcall(run_version_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
if not Version.isAtLeast("1.0.40") then
  System.alert("Please update Macro Handler")
  requestStop()
end
wait(200)
print("Combined with logging and flow control")