core-repository/org.meshtastic.core.repository/UiPrefs

UiPrefs

interface UiPrefs(source)

Reactive interface for general UI preferences.

Properties

appIntroCompleted

abstract val appIntroCompleted: StateFlow<Boolean>

bleAutoScan

abstract val bleAutoScan: StateFlow<Boolean>

Whether BLE scanning should auto-start when the Connections screen is opened.

eventThemeEnabled

abstract val eventThemeEnabled: StateFlow<Boolean>

Whether to apply an event edition's ambient theme (accent wash + custom typeface) app-wide (opt-out; default on).

firmwareUpdateNotificationKeys

abstract val firmwareUpdateNotificationKeys: StateFlow<Set<String>>

Keys for firmware-update notifications already scheduled on this device.

hasShownNotPairedWarning

abstract val hasShownNotPairedWarning: StateFlow<Boolean>

lastHeardIsRelative

abstract val lastHeardIsRelative: StateFlow<Boolean>

locale

abstract val locale: StateFlow<String>

networkAutoScan

abstract val networkAutoScan: StateFlow<Boolean>

Whether NSD network scanning should auto-start when the Connections screen is opened.

nodeFilters

abstract val nodeFilters: StateFlow<NodeFilterPrefs>

Every node-list filter, as one value.

nodeListDensity

abstract val nodeListDensity: StateFlow<String>

Active density mode stored as the enum name (e.g. "COMPLETE", "COMPACT").

nodeSort

abstract val nodeSort: StateFlow<Int>

selectedConnectionTransport

abstract val selectedConnectionTransport: StateFlow<DeviceType?>

User-selected Connections transport pane, or null when the screen should derive a default.

shouldShowChannel

abstract val shouldShowChannel: StateFlow<Boolean>

shouldShowHops

abstract val shouldShowHops: StateFlow<Boolean>

shouldShowLastHeard

abstract val shouldShowLastHeard: StateFlow<Boolean>

shouldShowLocation

abstract val shouldShowLocation: StateFlow<Boolean>

shouldShowPower

abstract val shouldShowPower: StateFlow<Boolean>

shouldShowRole

abstract val shouldShowRole: StateFlow<Boolean>

shouldShowSignal

abstract val shouldShowSignal: StateFlow<Boolean>

shouldShowTelemetry

abstract val shouldShowTelemetry: StateFlow<Boolean>

showFullMessageTimestamps

abstract val showFullMessageTimestamps: StateFlow<Boolean>

Whether conversation message headers and actions always show both the date and time.

showQuickChat

abstract val showQuickChat: StateFlow<Boolean>

theme

abstract val theme: StateFlow<Int>

unitsOverride

abstract val unitsOverride: StateFlow<Int>

The in-app units choice as a org.meshtastic.core.common.util.UnitsOverride value; 0 follows the OS locale.

Functions

recordFirmwareUpdateNotificationKey

abstract fun recordFirmwareUpdateNotificationKey(key: String)

Records a notification key after the platform notification has been scheduled successfully.

setAppIntroCompleted

abstract fun setAppIntroCompleted(completed: Boolean)

setBleAutoScan

abstract fun setBleAutoScan(enabled: Boolean)

setEventThemeEnabled

abstract fun setEventThemeEnabled(enabled: Boolean)

setHasShownNotPairedWarning

abstract fun setHasShownNotPairedWarning(shown: Boolean)

setLastHeardIsRelative

abstract fun setLastHeardIsRelative(value: Boolean)

setLocale

abstract fun setLocale(languageTag: String)

setNetworkAutoScan

abstract fun setNetworkAutoScan(enabled: Boolean)

setNodeListDensity

abstract fun setNodeListDensity(value: String)

setNodeSort

abstract fun setNodeSort(value: Int)

setSelectedConnectionTransport

abstract fun setSelectedConnectionTransport(type: DeviceType)

setShouldProvideNodeLocation

abstract fun setShouldProvideNodeLocation(nodeNum: Int, provide: Boolean)

setShouldShowChannel

abstract fun setShouldShowChannel(value: Boolean)

setShouldShowHops

abstract fun setShouldShowHops(value: Boolean)

setShouldShowLastHeard

abstract fun setShouldShowLastHeard(value: Boolean)

setShouldShowLocation

abstract fun setShouldShowLocation(value: Boolean)

setShouldShowPower

abstract fun setShouldShowPower(value: Boolean)

setShouldShowRole

abstract fun setShouldShowRole(value: Boolean)

setShouldShowSignal

abstract fun setShouldShowSignal(value: Boolean)

setShouldShowTelemetry

abstract fun setShouldShowTelemetry(value: Boolean)

setShowFullMessageTimestamps

abstract fun setShowFullMessageTimestamps(show: Boolean)

setShowQuickChat

abstract fun setShowQuickChat(show: Boolean)

setTheme

abstract fun setTheme(value: Int)

setUnitsOverride

abstract fun setUnitsOverride(value: Int)

shouldProvideNodeLocation

abstract fun shouldProvideNodeLocation(nodeNum: Int): StateFlow<Boolean>

updateNodeFilters

abstract fun updateNodeFilters(transform: (NodeFilterPrefs) -> NodeFilterPrefs)

Applies transform to the stored filters. Read-modify-write happens inside the store's own transaction.