RemoteListenableWorker

Artifact: androidx.work:work-multiprocess

Added in 2.6.0

Kotlin |Java

public abstract class RemoteListenableWorker extends ListenableWorker

java.lang.Object
↳	androidx.work.ListenableWorker
	↳	androidx.work.multiprocess.RemoteListenableWorker

Known direct subclasses

RemoteCoroutineWorker

RemoteCoroutineWorker

An implementation of RemoteListenableWorker that can bind to a remote process.

Is an implementation of a ListenableWorker that can bind to a remote process.

To be able to bind to a remote process, A RemoteListenableWorker needs additional arguments as part of its input Data.

The arguments (ARGUMENT_PACKAGE_NAME, ARGUMENT_CLASS_NAME) are used to determine the android.app.Service that the RemoteListenableWorker can bind to. startRemoteWork is then subsequently called in the process that the android.app.Service is running in.

Summary

Constants
`static final String`	`ARGUMENT_CLASS_NAME = "androidx.work.impl.workers.RemoteListenableWorker.ARGUMENT_CLASS_NAME"` The `ARGUMENT_PACKAGE_NAME`, `className` together determine the `ComponentName` that the `RemoteListenableWorker` binds to before calling `startRemoteWork`.
`static final String`	`ARGUMENT_PACKAGE_NAME = "androidx.work.impl.workers.RemoteListenableWorker.ARGUMENT_PACKAGE_NAME"` The `#ARGUMENT_PACKAGE_NAME`, `ARGUMENT_CLASS_NAME` together determine the `ComponentName` that the `RemoteListenableWorker` binds to before calling `startRemoteWork`.

Public constructors
`RemoteListenableWorker( @NonNull Context appContext, @NonNull WorkerParameters workerParams )`

Public methods
`abstract @NonNull ListenableFuture<ListenableWorker.Result>`	`startRemoteWork()` Override this method to define the work that needs to run in the remote process.
`final @NonNull ListenableFuture<ListenableWorker.Result>`	`startWork()` Override this method to start your actual background processing.

Inherited methods

From androidx.work.ListenableWorker

`final @NonNull Context`	`getApplicationContext()` Gets the application `android.content.Context`.
`@NonNull ListenableFuture<ForegroundInfo>`	`getForegroundInfoAsync()` Return an instance of `ForegroundInfo` if the `WorkRequest` is important to the user.
`final @NonNull UUID`	`getId()` Gets the ID of the `WorkRequest` that created this Worker.
`final @NonNull Data`	`getInputData()` Gets the input data.
`final @Nullable Network`	`@RequiresApi(value = 28) getNetwork()` Gets the `android.net.Network` to use for this Worker.
`final @IntRange(from = 0) int`	`getRunAttemptCount()` Gets the current run attempt count for this work.
`final int`	`@RequiresApi(value = 31) getStopReason()` Returns a reason why this worker has been stopped.
`final @NonNull Set<String>`	`getTags()` Gets a `java.util.Set` of tags associated with this Worker's `WorkRequest`.
`final @NonNull List<String>`	`@RequiresApi(value = 24) getTriggeredContentAuthorities()` Gets the list of content authorities that caused this Worker to execute.
`final @NonNull List<Uri>`	`@RequiresApi(value = 24) getTriggeredContentUris()` Gets the list of content `android.net.Uri`s that caused this Worker to execute.
`final boolean`	`isStopped()` Returns `true` if this Worker has been told to stop.
`void`	`onStopped()` This method is invoked when this Worker has been told to stop.
`final @NonNull ListenableFuture<Void>`	`setForegroundAsync(@NonNull ForegroundInfo foregroundInfo)` This specifies that the `WorkRequest` is long-running or otherwise important.
`@NonNull ListenableFuture<Void>`	`setProgressAsync(@NonNull Data data)` Updates `ListenableWorker` progress.

Constants

ARGUMENT_CLASS_NAME

Added in 2.6.0

public static final String ARGUMENT_CLASS_NAME = "androidx.work.impl.workers.RemoteListenableWorker.ARGUMENT_CLASS_NAME"

The ARGUMENT_PACKAGE_NAME, className together determine the ComponentName that the RemoteListenableWorker binds to before calling startRemoteWork.

ARGUMENT_PACKAGE_NAME

Added in 2.6.0

public static final String ARGUMENT_PACKAGE_NAME = "androidx.work.impl.workers.RemoteListenableWorker.ARGUMENT_PACKAGE_NAME"

The #ARGUMENT_PACKAGE_NAME, ARGUMENT_CLASS_NAME together determine the ComponentName that the RemoteListenableWorker binds to before calling startRemoteWork.

Public constructors

RemoteListenableWorker

Added in 2.6.0

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

Parameters
`@NonNull Context appContext`	The application `Context`
`@NonNull WorkerParameters workerParams`	`WorkerParameters` to setup the internal state of this worker

Public methods

startRemoteWork

Added in 2.6.0

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

Override this method to define the work that needs to run in the remote process. This method is called on the main thread.

A ListenableWorker has a well defined execution window to to finish its execution and return a androidx.work.ListenableWorker.Result. After this time has expired, the worker will be signalled to stop and its ListenableFuture will be cancelled. Note that the execution window also includes the cost of binding to the remote process.

The RemoteListenableWorker will also be signalled to stop when its constraints are no longer met.

Returns
`@NonNull ListenableFuture<ListenableWorker.Result>`	A `ListenableFuture` with the `Result` of the computation. If you cancel this Future, WorkManager will treat this unit of work as a `Result#failure()`.

startWork

Added in 2.6.0

public final @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).

Returns
`@NonNull ListenableFuture<ListenableWorker.Result>`	A `com.google.common.util.concurrent.ListenableFuture` with the `Result` of the computation. If you cancel this Future, WorkManager will treat this unit of work as failed.