store/com.siddharth.kmp.store/FreshnessBand

FreshnessBand

enum FreshnessBand : Enum<FreshnessBand>

How stale cached data is, on a time axis only — network state is deliberately NOT an input (that's a separate "am I online" concern). Drives a per-card freshness indicator ("Updated 2 min ago" → "Refresh now" → "Retry").

Entries

Initial

Never fetched and no error — hide the indicator.

Fresh

age <= ttl, no error — up to date.

Stale

ttl < age <= 3·ttl, no error — suggest a refresh.

VeryStale

age > 3·ttl, or a last error is present — urge a retry.

Properties

entries

val entries: EnumEntries<FreshnessBand>

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): FreshnessBand

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

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