Configuration.Builder

Builder

public Builder()

Creates a new Configuration.Builder.

build

public @NonNull Configuration build()

Builds a Configuration object.

setDefaultProcessName

public @NonNull Configuration.Builder setDefaultProcessName(@NonNull String processName)

Designates the primary process that WorkManager should schedule work in.

setExecutor

public @NonNull Configuration.Builder setExecutor(@NonNull Executor executor)

Specifies a custom Executor for WorkManager.

setInitializationExceptionHandler

public @NonNull Configuration.Builder setInitializationExceptionHandler(
    @NonNull Consumer<Throwable> exceptionHandler
)

Specifies a Consumer<Throwable> that can be used to intercept exceptions caused when trying to initialize WorkManager, that usually happens when WorkManager cannot access its internal datastore.

This exception handler will be invoked on a thread bound to getTaskExecutor.

setInputMergerFactory

public @NonNull Configuration.Builder setInputMergerFactory(@NonNull InputMergerFactory inputMergerFactory)

Specifies a custom InputMergerFactory for WorkManager.

setJobSchedulerJobIdRange

public @NonNull Configuration.Builder setJobSchedulerJobIdRange(int minJobSchedulerId, int maxJobSchedulerId)

Specifies the range of android.app.job.JobInfo IDs that can be used by WorkManager. WorkManager needs a range of at least 1000 IDs.

JobScheduler uses integers as identifiers for jobs, and WorkManager delegates to JobScheduler on certain API levels. In order to not clash job codes used in the rest of your app, you can use this method to tell WorkManager the valid range of job IDs that it can use.

The default values are 0 and Integer#MAX_VALUE.

setMaxSchedulerLimit

public @NonNull Configuration.Builder setMaxSchedulerLimit(int maxSchedulerLimit)

Specifies the maximum number of system requests made by WorkManager when using android.app.job.JobScheduler or android.app.AlarmManager.

By default, WorkManager might schedule a large number of alarms or JobScheduler jobs. If your app uses JobScheduler or AlarmManager directly, this might exhaust the OS-enforced limit on the number of jobs or alarms an app is allowed to schedule. To help manage this situation, you can use this method to reduce the number of underlying jobs and alarms that WorkManager might schedule.

When the application exceeds this limit, WorkManager maintains an internal queue of WorkRequests, and schedules them when slots become free.

WorkManager requires a minimum of MIN_SCHEDULER_LIMIT slots; this is also the default value. The total number of slots also cannot exceed 50.

setMinimumLoggingLevel

public @NonNull Configuration.Builder setMinimumLoggingLevel(int loggingLevel)

Specifies the minimum logging level, corresponding to the constants found in android.util.Log. For example, specifying VERBOSE will log everything, whereas specifying ERROR will only log errors and assertions.The default value is INFO.

setRunnableScheduler

public @NonNull Configuration.Builder setRunnableScheduler(@NonNull RunnableScheduler runnableScheduler)

Specifies the RunnableScheduler to be used by WorkManager. This is used by the in-process scheduler to keep track of timed work.

setSchedulingExceptionHandler

public @NonNull Configuration.Builder setSchedulingExceptionHandler(
    @NonNull Consumer<Throwable> schedulingExceptionHandler
)

Specifies a Consumer<Throwable> that can be used to intercept exceptions caused when trying to schedule WorkRequests. It allows the application to handle a Throwable throwable typically caused when trying to schedule WorkRequests.

This exception handler will be invoked on a thread bound to getTaskExecutor.

setTaskExecutor

public @NonNull Configuration.Builder setTaskExecutor(@NonNull Executor taskExecutor)

Specifies a Executor which will be used by WorkManager for all its internal book-keeping. For best performance this Executor should be bounded. For more information look at setQueryExecutor.

setWorkerFactory

public @NonNull Configuration.Builder setWorkerFactory(@NonNull WorkerFactory workerFactory)

Specifies a custom WorkerFactory for WorkManager.