ListenableWorker

public ListenableWorker(
    @NonNull Context appContext,
    @NonNull WorkerParameters workerParams
)

public final @NonNull Context getApplicationContext()

Gets the application android.content.Context.

public @NonNull ListenableFuture<ForegroundInfo> getForegroundInfoAsync()

Return an instance of ForegroundInfo if the WorkRequest is important to the user. In this case, WorkManager provides a signal to the OS that the process should be kept alive while this work is executing.

Prior to Android S, WorkManager manages and runs a foreground service on your behalf to execute the WorkRequest, showing the notification provided in the ForegroundInfo. To update this notification subsequently, the application can use android.app.NotificationManager.

Starting in Android S and above, WorkManager manages this WorkRequest using an immediate job.

public final @NonNull UUID getId()

Gets the ID of the WorkRequest that created this Worker.

public final @NonNull Data getInputData()

Gets the input data. Note that in the case that there are multiple prerequisites for this Worker, the input data has been run through an InputMerger.

@RequiresApi(value = 28)
public final @Nullable Network getNetwork()

Gets the android.net.Network to use for this Worker. This method returns null if there is no network needed for this work request.

public final @IntRange(from = 0) int getRunAttemptCount()

Gets the current run attempt count for this work. Note that for periodic work, this value gets reset between periods.

@RequiresApi(value = 31)
public final int getStopReason()

Returns a reason why this worker has been stopped. Return values match values of JobParameters.STOP_REASON_* constants, e.g. STOP_REASON_CONSTRAINT_CHARGING or STOP_REASON_UNKNOWN

If a worker hasn't been stopped, STOP_REASON_NOT_STOPPED is returned.

public final @NonNull Set<String> getTags()

Gets a java.util.Set of tags associated with this Worker's WorkRequest.

@RequiresApi(value = 24)
public final @NonNull List<String> getTriggeredContentAuthorities()

Gets the list of content authorities that caused this Worker to execute. See JobParameters#getTriggeredContentAuthorities() for relevant JobScheduler code.

@RequiresApi(value = 24)
public final @NonNull List<Uri> getTriggeredContentUris()

Gets the list of content android.net.Uris that caused this Worker to execute. See JobParameters#getTriggeredContentUris() for relevant JobScheduler code.

public final boolean isStopped()

Returns true if this Worker has been told to stop. This could be because of an explicit cancellation signal by the user, or because the system has decided to preempt the task. In these cases, the results of the work will be ignored by WorkManager and it is safe to stop the computation. WorkManager will retry the work at a later time if necessary.

public void onStopped()

This method is invoked when this Worker has been told to stop. At this point, the com.google.common.util.concurrent.ListenableFuture returned by the instance of startWork is also cancelled. This could happen due to an explicit cancellation signal by the user, or because the system has decided to preempt the task. In these cases, the results of the work will be ignored by WorkManager. All processing in this method should be lightweight - there are no contractual guarantees about which thread will invoke this call, so this should not be a long-running or blocking operation.

public final @NonNull ListenableFuture<Void> setForegroundAsync(@NonNull ForegroundInfo foregroundInfo)

This specifies that the WorkRequest is long-running or otherwise important. In this case, WorkManager provides a signal to the OS that the process should be kept alive if possible while this work is executing.

Calls to setForegroundAsync *must* complete before a ListenableWorker signals completion by returning a Result.

Under the hood, WorkManager manages and runs a foreground service on your behalf to execute this WorkRequest, showing the notification provided in ForegroundInfo.

Calling setForegroundAsync will fail with an IllegalStateException when the process is subject to foreground service restrictions. Consider using setExpedited and getForegroundInfoAsync instead.

public @NonNull ListenableFuture<Void> setProgressAsync(@NonNull Data data)

Updates ListenableWorker progress.

@MainThread
public abstract @NonNull ListenableFuture<ListenableWorker.Result> startWork()

Override this method to start your actual background processing. This method is called on the main thread.

A ListenableWorker has a well defined execution window to to finish its execution and return a Result. After this time has expired, the worker will be signalled to stop and its com.google.common.util.concurrent.ListenableFuture will be cancelled.

The future will also be cancelled if this worker is stopped for any reason (see onStopped).