supabase-offline-kt/io.github.nesfeder.supabase.offline/NetworkStatus

NetworkStatus

enum NetworkStatus : Enum<NetworkStatus> (source)

Whether the library believes it can reach the network, as SyncStatus.network reports it.

It is a hint, never a gate: a request the app makes is tried whatever this says, because a connectivity monitor can be wrong either way. It decides only when the library tries by itself, and whether a waiting refresh reads as RefreshState.Paused.

The set is closed: these four cases are every status, so a when over them stays exhaustive.

Entries

UNKNOWN

Not known yet: the monitor, or the app's own signal, has not said. Treated as online.

ONLINE

The device has a network the monitor, or the app's own signal, takes as usable.

OFFLINE

The device has no usable network, as the monitor or the app's own signal says.

DISABLED

The app turned the library's network access off with Offline.disableNetwork: nothing is sent until Offline.enableNetwork.

Properties

entries

val entries: EnumEntries<NetworkStatus>

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

Functions

valueOf

fun valueOf(value: String): NetworkStatus

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

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