backgrounder/com.happycodelucky.backgrounder/NetworkRequirement

NetworkRequirement

enum NetworkRequirement : Enum<NetworkRequirement>

Network connectivity requirement for a WorkRequest.

Unmetered is honoured on all platforms by the library's pre-execution reachability gate (ReachabilityStatus.isDataMetered == false). On iOS, the OS-level scheduling hint (BGProcessingTaskRequest.requiresNetworkConnectivity) is downgraded to Any (logged once) because BGTaskScheduler has no metered/unmetered concept — but the gate still blocks dispatch until an unmetered connection is available.

Entries

None

No network requirement — work runs regardless of connectivity.

Any

Any active network. Maps to Android CONNECTED / iOS requiresNetworkConnectivity = true.

Unmetered

Unmetered network (Wi-Fi / Ethernet). Honoured by the reachability gate on all platforms. Android additionally honours this at the OS dispatch level via NetworkType.UNMETERED.

Properties

entries

val entries: EnumEntries<NetworkRequirement>

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

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

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