core-ui/org.meshtastic.core.ui.util/PermissionGateAction

PermissionGateAction

enum PermissionGateAction : Enum<PermissionGateAction> (source)

The step a feature should take when the user asks for something a runtime permission gates.

This is the decision tree from the Android permissions guidance (https://developer.android.com/training/permissions/requesting) expressed as data, so a call site can honour it with an exhaustive when instead of an ad-hoc boolean check. The branch that is easiest to miss — and the one this type exists to make unmissable — is SHOW_RATIONALE: the guidance requires an educational UI before a re-request, and that request is the one that can turn a recoverable denial into a permanent one.

Entries

PROCEED

The permission is held; run the gated action.

REQUEST

Never asked. The guidance says to request directly here — a rationale before the first prompt is noise.

SHOW_RATIONALE

Denied at least once while the system will still prompt. Show an educational UI naming what the feature does and what stays disabled if declined, with a way to back out, and only re-request if the user agrees.

OPEN_SETTINGS

The system will no longer show its dialog; requesting is a silent no-op. Offer the app's settings page.

Properties

entries

val entries: EnumEntries<PermissionGateAction>

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

valueOf

fun valueOf(value: String): PermissionGateAction

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<PermissionGateAction>

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