core-model/org.meshtastic.core.model.util/BeaconJoinOption

BeaconJoinOption

enum BeaconJoinOption : Enum<BeaconJoinOption> (source)

How a received Mesh Beacon invitation can be joined, given the connected radio's current settings.

Entries

ADD

Add the offered channel to a free secondary slot with no retune/reboot (mesh shares the radio's frequency).

SWITCH

Retune the radio's primary channel (and LoRa preset/region) onto the offered mesh — reboots the radio.

NONE

The beacon carries no join offer (message-only) — nothing to join.

Properties

entries

val entries: EnumEntries<BeaconJoinOption>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

schemaDescriptionRes

fun Enum<*>.schemaDescriptionRes(): StringResource?

The schema's one-sentence explanation of this enum value, or null where it has none.

schemaLabelRes

fun Enum<*>.schemaLabelRes(): StringResource?

The schema's label for this enum value, or null where the schema does not name it. A picker shows this in place of the constant's Kotlin name, and falls back to that name when it is null, so a value the schema has not reached still renders.

valueOf

fun valueOf(value: String): BeaconJoinOption

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<BeaconJoinOption>

Returns an array containing the constants of this enum type, in the order they're declared.