← Host capabilities

Host.systemBackHistory

luastra/host
Host.systemBackHistory(intentId: number): RequestId

Delegates a specific system-Back intent to the host history mechanism and returns a RequestId. It preserves platform navigation behavior when an earlier history entry is available.

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.systemBackHistory when Navigation.decideBack determines that browser or host history owns the next Back step. Do not use it when an application modal or local route must close first.

Parameters

ParameterType / valuesDescription
intentIdnumberID of the pending system-Back intent delegated to host history.

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.systemBackHistory(intentId)

Complete inventory

View all pages in Host capabilities
← Previous: Host.systemBackHandledNext: Host.systemBackExit →