Host.systemBackHandled
luastra/hostHost.systemBackHandled(intentId: number): RequestId
Acknowledges that the application consumed a specific system-Back intent without delegating to browser history or exiting. The intent ID prevents an unrelated or stale Back request from being acknowledged.
Before you use it
Add luastra/host to this module's dependencies in luastra.json, then import it with require("luastra/host"). Declare navigation.history in luastra.json. Save the returned RequestId with its purpose and implement app.resolve.
How it fits
The function starts an asynchronous host request and returns immediately. app.resolve receives its success payload or stable failure code; availability and permission can vary by host.
When to use it
Use Host.systemBackHandled after closing an open modal or handling Back entirely in application state. Call it once for the current intent after the state change has been accepted.
Parameters
| Parameter | Type / values | Description |
|---|---|---|
| intentId | number | ID of the pending system-Back intent consumed by application state. |
Returns
RequestId — an opaque request identifier used to correlate the asynchronous completion in app.resolve.
What happens next
A RequestId now, followed later by one matching app.resolve completion.
Failures and fixes
Undeclared capability, unavailable host support, denied permission, invalid input, deadline, network, or internal failure reaches the bounded failure path. Public completion codes are CANCELLED, DEADLINE, FORBIDDEN, INTERNAL, NETWORK, UNAUTHORIZED, and VALIDATION.
Availability
Public-source alpha capability API in 0.5.0-alpha; verify each claimed host independently.
Focused example
local Host = require("luastra/host")
Host.systemBackHandled(intentId)