Constraints.Builder

public Builder()

@RequiresApi(value = 24)
public final @NonNull Constraints.Builder addContentUriTrigger(@NonNull Uri uri, boolean triggerForDescendants)

Sets whether the WorkRequest should run when a local content: Uri is updated. This functionality is identical to the one found in JobScheduler and is described in JobInfo.Builder#addTriggerContentUri(android.app.job.JobInfo.TriggerContentUri).

public final @NonNull Constraints build()

Generates the Constraints from this Builder.

@RequiresApi(value = 21)
public final @NonNull Constraints.Builder setRequiredNetworkRequest(
    @NonNull NetworkRequest networkRequest,
    @NonNull NetworkType networkType
)

Sets whether device should have a particular NetworkRequest for the WorkRequest to run on the API levels >= 28 (Android P). For the older API levels, networkType will be used instead on the older platforms.

NetworkRequest with NetworkSpecifier set aren't supported, as well as NetworkRequest with setIncludeOtherUidNetworks set. IllegalArgumentException will be thrown if such requests are passed.

public final @NonNull Constraints.Builder setRequiredNetworkType(@NonNull NetworkType networkType)

Sets whether device should have a particular NetworkType for the WorkRequest to run. The default value is NetworkType.NOT_REQUIRED.

public final @NonNull Constraints.Builder setRequiresBatteryNotLow(boolean requiresBatteryNotLow)

Sets whether device battery should be at an acceptable level for the WorkRequest to run. The default value is false.

public final @NonNull Constraints.Builder setRequiresCharging(boolean requiresCharging)

Sets whether device should be charging for the WorkRequest to run. The default value is false.

@RequiresApi(value = 23)
public final @NonNull Constraints.Builder setRequiresDeviceIdle(boolean requiresDeviceIdle)

Sets whether device should be idle for the WorkRequest to run. The default value is false.

public final @NonNull Constraints.Builder setRequiresStorageNotLow(boolean requiresStorageNotLow)

Sets whether the device's available storage should be at an acceptable level for the WorkRequest to run. The default value is false.

@RequiresApi(value = 26)
public final @NonNull Constraints.Builder setTriggerContentMaxDelay(@NonNull Duration duration)

Sets the maximum delay that is allowed from the first time a content: Uri change is detected to the time when the WorkRequest is scheduled. This functionality is identical to the one found in JobScheduler and is described in JobInfo.Builder#setTriggerContentMaxDelay(long).

@RequiresApi(value = 24)
public final @NonNull Constraints.Builder setTriggerContentMaxDelay(long duration, @NonNull TimeUnit timeUnit)

Sets the maximum delay that is allowed from the first time a content: Uri change is detected to the time when the WorkRequest is scheduled. This functionality is identical to the one found in JobScheduler and is described in JobInfo.Builder#setTriggerContentMaxDelay(long).

@RequiresApi(value = 26)
public final @NonNull Constraints.Builder setTriggerContentUpdateDelay(@NonNull Duration duration)

Sets the delay that is allowed from the time a content: Uri change is detected to the time when the WorkRequest is scheduled. If there are more changes during this time, the delay will be reset to the start of the most recent change. This functionality is identical to the one found in JobScheduler and is described in JobInfo.Builder#setTriggerContentUpdateDelay(long).

@RequiresApi(value = 24)
public final @NonNull Constraints.Builder setTriggerContentUpdateDelay(long duration, @NonNull TimeUnit timeUnit)

Sets the delay that is allowed from the time a content: Uri change is detected to the time when the WorkRequest is scheduled. If there are more changes during this time, the delay will be reset to the start of the most recent change. This functionality is identical to the one found in JobScheduler and is described in JobInfo.Builder#setTriggerContentUpdateDelay(long).