JobConfig (library 1.2.4 API)

java.lang.Object
- com.evernote.android.job.JobConfig

```
public final class JobConfig
extends Object
```
A global configuration for the job library.

See JobCat for settings to enable/disable logging.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`addLogger(JobLogger logger)` Add a global logger for the job library, which will be notified about each log statement.
`static void`	`forceApi(JobApi api)` WARNING: You shouldn't call this method.
`static Clock`	`getClock()`
`static ExecutorService`	`getExecutorService()`
`static int`	`getJobIdOffset()`
`static long`	`getJobReschedulePause()`
`static boolean`	`isAllowSmallerIntervalsForMarshmallow()` Checks whether a smaller interval and flex are allowed for periodic jobs.
`static boolean`	`isApiEnabled(JobApi api)`
`static boolean`	`isCloseDatabase()`
`static boolean`	`isForceAllowApi14()`
`static boolean`	`isForceRtc()`
`static boolean`	`isLogcatEnabled()`
`(package private) static boolean`	`isSkipJobReschedule()`
`static void`	`removeLogger(JobLogger logger)` Remove a global logger.
`static void`	`reset()` Resets all adjustments in the config.
`static void`	`setAllowSmallerIntervalsForMarshmallow(boolean allowSmallerIntervals)` Option to override the minimum period and minimum flex for periodic jobs.
`static void`	`setApiEnabled(JobApi api, boolean enabled)` WARNING: Please use this method carefully.
`(package private) static void`	`setClock(Clock clock)`
`static void`	`setCloseDatabase(boolean closeDatabase)` Controls whether the internal database should be closed after each access to clean up resources.
`static void`	`setExecutorService(ExecutorService executorService)` Overrides the executor service for all parallel execution.
`static void`	`setForceAllowApi14(boolean forceAllowApi14)` On some devices for some reason all broadcast receiver and services are disabled.
`static void`	`setForceRtc(boolean forceRtc)`
`static void`	`setJobIdOffset(int jobIdOffset)` Adds an offset to the job IDs.
`static void`	`setJobReschedulePause(long pause, TimeUnit timeUnit)` Overrides the default job reschedule pause.
`static void`	`setLogcatEnabled(boolean enabled)` Global switch to enable or disable printing log messages to Logcat.
`(package private) static void`	`setSkipJobReschedule(boolean skipJobReschedule)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - isApiEnabled
```
public static boolean isApiEnabled(@NonNull
                                   JobApi api)
```
    Returns:
    
    Whether the given API is enabled. By default all APIs are enabled, although the current device may not support it.
  - setApiEnabled
```
public static void setApiEnabled(@NonNull
                                 JobApi api,
                                 boolean enabled)
```
    WARNING: Please use this method carefully. It's only meant to be used for testing purposes and could break how the library works.
    
    Programmatic switch to enable or disable the given API. This only has an impact for new scheduled jobs.
    
    Parameters:
    
    api - The API which should be enabled or disabled.
    
    enabled - Whether the API should be enabled or disabled.
  - forceApi
```
public static void forceApi(@NonNull
                            JobApi api)
```
    WARNING: You shouldn't call this method. It only exists for testing and debugging purposes. The JobManager automatically decides which API suits best for a Job.
    
    Parameters:
    
    api - The JobApi which will be used for future scheduled JobRequests.
  - isAllowSmallerIntervalsForMarshmallow
```
public static boolean isAllowSmallerIntervalsForMarshmallow()
```
    Checks whether a smaller interval and flex are allowed for periodic jobs. That's helpful for testing purposes.
    
    Returns:
    
    Whether a smaller interval and flex than the minimum values are allowed for periodic jobs are allowed. The default value is false.
  - setAllowSmallerIntervalsForMarshmallow
```
public static void setAllowSmallerIntervalsForMarshmallow(boolean allowSmallerIntervals)
```
    Option to override the minimum period and minimum flex for periodic jobs. This is useful for testing purposes. This method only works for Android M and earlier. Later versions throw an exception.
    
    Parameters:
    
    allowSmallerIntervals - Whether a smaller interval and flex than the minimum values are allowed for periodic jobs are allowed. The default value is false.
  - setForceAllowApi14
```
public static void setForceAllowApi14(boolean forceAllowApi14)
```
    On some devices for some reason all broadcast receiver and services are disabled. This library cannot work properly in this case. This switch allows to use the AlarmManager as fallback even in such a weird state.
    
    If the value is true, then this suppresses the JobManagerCreateException during the creation of the job manager.
    
    Parameters:
    
    forceAllowApi14 - Whether API 14 should be used as fallback in all scenarios. The default value is false.
  - isForceAllowApi14
```
public static boolean isForceAllowApi14()
```
    Returns:
    
    Whether API 14 should be used as fallback in all scenarios. The default value is false.
  - addLogger
```
public static boolean addLogger(@NonNull
                                JobLogger logger)
```
    Add a global logger for the job library, which will be notified about each log statement.
    
    Parameters:
    
    logger - Your desired logger.
    
    Returns:
    
    true if the logger was added. Returns false if the logger was already added.
  - removeLogger
```
public static void removeLogger(@NonNull
                                JobLogger logger)
```
    Remove a global logger.
    
    Parameters:
    
    logger - Your desired logger.
    
    See Also:
    
    addLogger(JobLogger)
  - setLogcatEnabled
```
public static void setLogcatEnabled(boolean enabled)
```
    Global switch to enable or disable printing log messages to Logcat.
    
    Parameters:
    
    enabled - Whether or not to print all log messages. The default value is true.
  - isLogcatEnabled
```
public static boolean isLogcatEnabled()
```
    Returns:
    
    Whether logging is enabled for this library. The default value is true.
  - getJobReschedulePause
```
public static long getJobReschedulePause()
```
    Returns:
    
    The pause of job reschedule service in milliseconds.
  - setJobReschedulePause
```
public static void setJobReschedulePause(long pause,
                                         @NonNull
                                         TimeUnit timeUnit)
```
    Overrides the default job reschedule pause. The default value is 3 seconds.
    
    Parameters:
    
    pause - The new pause.
    
    timeUnit - The time unit of the pause argument.
  - isSkipJobReschedule
```
static boolean isSkipJobReschedule()
```
  - setSkipJobReschedule
```
static void setSkipJobReschedule(boolean skipJobReschedule)
```
  - getJobIdOffset
```
public static int getJobIdOffset()
```
    Returns:
    
    The offset for the very first job ID. The default value is 0 and very first job ID will be 1.
  - setJobIdOffset
```
public static void setJobIdOffset(int jobIdOffset)
```
    Adds an offset to the job IDs. Job IDs are generated and usually start with 1. This offset shifts the very first job ID.
    
    Parameters:
    
    jobIdOffset - The offset for the very first job ID.
  - isForceRtc
```
public static boolean isForceRtc()
```
    Returns:
    
    Whether the alarm time should use System.currentTimeMillis() (wall clock time in UTC). The default value is false and will use the alarm time in SystemClock.elapsedRealtime() (time since boot, including sleep).
  - setForceRtc
```
public static void setForceRtc(boolean forceRtc)
```
    Parameters:
    
    forceRtc - Force using the alarm time in System.currentTimeMillis() (wall clock time in UTC). The default value is false and will use the alarm time in SystemClock.elapsedRealtime() (time since boot, including sleep).
  - getClock
```
public static Clock getClock()
```
    Returns:
    
    A helper providing the system time
  - setClock
```
static void setClock(Clock clock)
```
  - getExecutorService
```
public static ExecutorService getExecutorService()
```
    Returns:
    
    The executor service for all parallel execution.
  - setExecutorService
```
public static void setExecutorService(@NonNull
                                      ExecutorService executorService)
```
    Overrides the executor service for all parallel execution. This could be helpful for Espresso tests.
    
    Parameters:
    
    executorService - The new executor service.
  - isCloseDatabase
```
public static boolean isCloseDatabase()
```
    Returns:
    
    Whether the internal database is closed after each access. The default value is false.
  - setCloseDatabase
```
public static void setCloseDatabase(boolean closeDatabase)
```
    Controls whether the internal database should be closed after each access to clean up resources. The default value is false.
    
    Parameters:
    
    closeDatabase - Whether to close the database after each access.
  - reset
```
public static void reset()
```
    Resets all adjustments in the config.

Class JobConfig

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isApiEnabled

setApiEnabled

forceApi

isAllowSmallerIntervalsForMarshmallow

setAllowSmallerIntervalsForMarshmallow

setForceAllowApi14

isForceAllowApi14

addLogger

removeLogger

setLogcatEnabled

isLogcatEnabled

getJobReschedulePause

setJobReschedulePause

isSkipJobReschedule

setSkipJobReschedule

getJobIdOffset

setJobIdOffset

isForceRtc

setForceRtc

getClock

setClock

getExecutorService

setExecutorService

isCloseDatabase

setCloseDatabase

reset