core/io.neuralheads.kmpworker.core/Constraints

Constraints

@Serializable

data class Constraints(val requiresInternet: Boolean = false, val requiresCharging: Boolean = false, val batteryNotLow: Boolean = false, val requiresDeviceIdle: Boolean = false, val contentUris: List<String> = emptyList())

Platform conditions that must be satisfied before a task can execute.

Platform support matrix: | Constraint | Android | iOS | |--------------------|---------|---------| | requiresInternet | ✅ | Partial | | requiresCharging | ✅ | ❌ | | batteryNotLow | ✅ | ❌ |

On iOS, only internet connectivity is partially respected via BGProcessingTaskRequest.

Constructors

Constraints

constructor(requiresInternet: Boolean = false, requiresCharging: Boolean = false, batteryNotLow: Boolean = false, requiresDeviceIdle: Boolean = false, contentUris: List<String> = emptyList())

Properties

batteryNotLow

val batteryNotLow: Boolean = false

Task should only run when battery level is not critically low. Android only.

contentUris

val contentUris: List<String>

Content URIs to observe for changes. Android only. When any of these URIs change, the task will be triggered.

requiresCharging

val requiresCharging: Boolean = false

Task should only run when the device is charging. Android only.

requiresDeviceIdle

val requiresDeviceIdle: Boolean = false

Task should only run when the device is idle. Android only (API 23+).

requiresInternet

val requiresInternet: Boolean = false

Task should only run when a network connection is available.