core/org.meshtastic.sdk/StoreForwardApi

StoreForwardApi

interface StoreForwardApi(source)

API for interacting with Store-and-Forward (S&F) nodes on the mesh.

S&F nodes temporarily store messages for offline nodes and deliver them when the target comes back online. This API enables clients to discover S&F servers, request missed messages, and query S&F statistics.

Note: This API requires firmware support for the STORE_FORWARD_APP port number. Not all nodes on the mesh will have S&F capabilities.

Access via RadioClient.storeForward (available after connection).

Since

0.2.0

Properties

Link copied to clipboard
abstract val events: Flow<StoreForwardEvent>

Flow of S&F-specific events (heartbeats, delivery confirmations, etc.).

Link copied to clipboard
abstract val servers: StateFlow<List<NodeId>>

Known S&F server nodes on the mesh.

Functions

Link copied to clipboard
abstract suspend fun requestHistory(since: Int? = null, server: NodeId? = null): AdminResult<Int>

Request delivery of messages stored for this node since the given timestamp.

Link copied to clipboard
abstract suspend fun requestStats(server: NodeId? = null): AdminResult<StoreForwardStats>

Query statistics from a Store-and-Forward server.

Generated by Dokka
© 2026 Copyright