Macro Handler

Macro Handler

Android Automation Platform

Object MethodDate and Time

TimeSpan:format(pattern?)

Formats the duration: patterns use HH, mm, ss and SSS; without a pattern the result is "1h 2m 3s".

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

This is an object method: call it with a colon on a TimeSpan object from a factory call such as TimeSpan.fromSeconds(...) (span:<method>(...)). The global TimeSpan table does not have this method.

When To Use It

For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.

Parameters and Return

Optional: pattern (omit to pass nil and use the runtime default). Returns a string.

Best Combined With

A strong combination is to measure with Stopwatch, log with DateTime, and compare durations with TimeSpan.

Example Usage

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

lua
Try in Editor →
local span = TimeSpan.fromSeconds(90)
local result = span:format("HH:mm:ss")

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 span = TimeSpan.fromSeconds(90)
local result = span:format("HH:mm:ss")

Simple

Wraps the base call with minimal flow control.

Simple
lua
Try in Editor →
local stepOk = true
local span = TimeSpan.fromSeconds(90)
local result = span:format("HH:mm:ss")
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 span = TimeSpan.fromSeconds(90)
  local result = span:format("HH:mm:ss")
end)

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

Detailed

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

Detailed
lua
Try in Editor →
-- For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.
local function run_format_step()
  local span = TimeSpan.fromSeconds(90)
  local result = span:format("HH:mm:ss")
end

local ok, err = pcall(run_format_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 watch = Stopwatch()
watch:start()
local span = TimeSpan.fromSeconds(90)
local result = span:format("HH:mm:ss")
print("Elapsed ms: " .. tostring(watch:elapsedMs()))