Params (jobqueue API)

java.lang.Object
- com.birbit.android.jobqueue.Params

```
public class Params
extends java.lang.Object
```
Job builder object to have a more readable design. Methods can be chained to have more readable code.

Field Summary

Fields
Modifier and Type Field and Description

static long FOREVER
Used in delay / override deadline.

static long NEVER
Used in delay / override deadline.

Fields
Modifier and Type	Field and Description
`static long`	`FOREVER` Used in delay / override deadline.
`static long`	`NEVER` Used in delay / override deadline.

Constructor Summary

Constructors
Constructor and Description

Params(int priority)

Constructors
Constructor and Description
`Params(int priority)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Params`	`addTags(java.lang.String... newTags)` Attaches given tags to the Job.
`Params`	`clearTags()`
`Params`	`delayInMs(long delayMs)` Delays the job in given ms.
`java.lang.Boolean`	`getCancelOnDeadline()` Returns what JobManager will do if job reaches its deadline.
`long`	`getDeadlineMs()`
`long`	`getDelayMs()`
`java.lang.String`	`getGroupId()`
`int`	`getPriority()`
`java.lang.String`	`getSingleId()`
`java.util.HashSet<java.lang.String>`	`getTags()`
`Params`	`groupBy(java.lang.String groupId)` Sets the group id.
`boolean`	`isNetworkRequired()`
`boolean`	`isPersistent()`
`boolean`	`isUnmeteredNetworkRequired()`
`Params`	`overrideDeadlineToCancelInMs(long deadlineInMs)` Set a deadline on the job's constraints.
`Params`	`overrideDeadlineToRunInMs(long deadlineInMs)` Set a deadline on the job's constraints.
`Params`	`persist()` Marks the job as persistent.
`Params`	`removeTags(java.lang.String... oldTags)` Removes the given tags from the Job.
`Params`	`requireNetwork()` Sets the Job as requiring network.
`Params`	`requireUnmeteredNetwork()` Sets the Job as requiring UNMETERED network.
`Params`	`setDelayMs(long delayMs)` convenience method to set delay
`Params`	`setGroupId(java.lang.String groupId)` convenience method to set group id.
`Params`	`setPersistent(boolean persistent)` convenience method to set whether `JobManager` should persist this job or not.
`Params`	`setRequiresNetwork(boolean requiresNetwork)` Convenience method to set network requirement.
`Params`	`setRequiresUnmeteredNetwork(boolean requiresUnmeteredNetwork)` Convenience method to set unmetered network requirement.
`Params`	`setSingleId(java.lang.String singleId)` convenience method to set single id.
`boolean`	`shouldCancelOnDeadline()`
`Params`	`singleInstanceBy(java.lang.String singleId)` Sets the single instance id.

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

- Field Detail
  - FOREVER
```
public static final long FOREVER
```
    Used in delay / override deadline.
    
    See Also:
    
    Constant Field Values
  - NEVER
```
public static final long NEVER
```
    Used in delay / override deadline.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Params
```
public Params(int priority)
```
    Parameters:
    
    priority - higher = better
- Method Detail
  - requireNetwork
```
public Params requireNetwork()
```
    Sets the Job as requiring network.
    This method has no effect if you've already called requireUnmeteredNetwork().
    
    Returns:
    
    this
  - requireUnmeteredNetwork
```
public Params requireUnmeteredNetwork()
```
    Sets the Job as requiring UNMETERED network.
    
    Returns:
    
    this
  - groupBy
```
public Params groupBy(java.lang.String groupId)
```
    Sets the group id. Jobs in the same group are guaranteed to execute sequentially.
    
    Parameters:
    
    groupId - which group this job belongs (can be null of course)
    
    Returns:
    
    this
  - singleInstanceBy
```
public Params singleInstanceBy(java.lang.String singleId)
```
    Sets the single instance id. If there is another Job with the same single id queued and not yet running, this Job will get Job.onCancel(int, Throwable) called immediately after Job.onAdded() and only the previous Job will run. That is, Job.onRun() will only be called once.
    If no group id was set, one will be set automatically.
    
    Parameters:
    
    singleId - which single instance group this job belongs to (can be null of course)
    
    Returns:
    
    this
  - persist
```
public Params persist()
```
    Marks the job as persistent. Make sure your job is serializable.
    
    Returns:
    
    this
  - delayInMs
```
public Params delayInMs(long delayMs)
```
    Delays the job in given ms.
    
    Parameters:
    
    delayMs - .
    
    Returns:
    
    this
  - setRequiresNetwork
```
public Params setRequiresNetwork(boolean requiresNetwork)
```
    Convenience method to set network requirement.
    If you call this method with true and you've already called requireUnmeteredNetwork(), this method has no effect.
    
    Parameters:
    
    requiresNetwork - true|false
    
    Returns:
    
    this
    
    See Also:
    
    requireNetwork()
  - setRequiresUnmeteredNetwork
```
public Params setRequiresUnmeteredNetwork(boolean requiresUnmeteredNetwork)
```
    Convenience method to set unmetered network requirement.
    If you call this method with false and you've already called requireNetwork(), this method has no effect.
    
    Parameters:
    
    requiresUnmeteredNetwork - true|false
    
    Returns:
    
    this
    
    See Also:
    
    requireUnmeteredNetwork()
  - setGroupId
```
public Params setGroupId(java.lang.String groupId)
```
    convenience method to set group id.
    
    Parameters:
    
    groupId - The group id for the job
    
    Returns:
    
    this
  - setSingleId
```
public Params setSingleId(java.lang.String singleId)
```
    convenience method to set single id.
    
    Parameters:
    
    singleId - The single instance run id for the job
    
    Returns:
    
    this
  - setPersistent
```
public Params setPersistent(boolean persistent)
```
    convenience method to set whether JobManager should persist this job or not.
    
    Parameters:
    
    persistent - true|false
    
    Returns:
    
    this
  - setDelayMs
```
public Params setDelayMs(long delayMs)
```
    convenience method to set delay
    
    Parameters:
    
    delayMs - in ms
    
    Returns:
    
    this
  - addTags
```
public Params addTags(java.lang.String... newTags)
```
    Attaches given tags to the Job. These are initially used for cancelling or querying jobs but usage will be extended
    
    Parameters:
    
    newTags - List of tags to add
    
    Returns:
    
    this
  - removeTags
```
public Params removeTags(java.lang.String... oldTags)
```
    Removes the given tags from the Job.
    
    Parameters:
    
    oldTags - List of tags to be removed
    
    Returns:
    
    this
  - clearTags
```
public Params clearTags()
```
  - overrideDeadlineToRunInMs
```
public Params overrideDeadlineToRunInMs(long deadlineInMs)
```
    Set a deadline on the job's constraints. After this deadline is reached, the job is run regardless of its constraints.
    Note that even if a job reaches its deadline, JobManager still respects constraints like groupId because when multiple jobs use the same groupId, they usually access shared resources so it is important to respect groupId while running jobs in parallel.
    You can check if a job reached its deadline or not via Job.isDeadlineReached().
    If you call this method, you cannot call overrideDeadlineToCancelInMs(long).
    
    Parameters:
    
    deadlineInMs - The deadline in milliseconds for the constraints.
    
    Returns:
    
    this
    
    See Also:
    
    overrideDeadlineToCancelInMs(long)
  - overrideDeadlineToCancelInMs
```
public Params overrideDeadlineToCancelInMs(long deadlineInMs)
```
    Set a deadline on the job's constraints. After this deadline is reached, the job will be cancelled regardless of its constraints with CancelReason.REACHED_DEADLINE.
    For instance, if you have a job that requires network and if network becomes available at the time deadline is reached, the job will still be cancelled without being run.
    You can check if a job reached its deadline or not via Job.isDeadlineReached().
    Note that even if a job reaches its deadline, JobManager still respects constraints like groupId because when multiple jobs use the same groupId, they usually access shared resources so it is important to respect groupId while running jobs in parallel.
    If you call this method, you cannot call overrideDeadlineToRunInMs(long).
    
    Parameters:
    
    deadlineInMs - The deadline in milliseconds for the constraints.
    
    Returns:
    
    this
    
    See Also:
    
    overrideDeadlineToRunInMs(long)
  - getGroupId
```
public java.lang.String getGroupId()
```
  - getSingleId
```
public java.lang.String getSingleId()
```
  - isPersistent
```
public boolean isPersistent()
```
  - getPriority
```
public int getPriority()
```
  - getDelayMs
```
public long getDelayMs()
```
  - getDeadlineMs
```
public long getDeadlineMs()
```
  - getCancelOnDeadline
```
public java.lang.Boolean getCancelOnDeadline()
```
    Returns what JobManager will do if job reaches its deadline.
    It will be null if Job does not have a deadline.
    
    Returns:
    
    null if job does not have a deadline, true if it will be cancelled when it hits the deadline, false if it will be run when it hits the deadline.
  - getTags
```
public java.util.HashSet<java.lang.String> getTags()
```
  - shouldCancelOnDeadline
```
public boolean shouldCancelOnDeadline()
```
  - isNetworkRequired
```
public boolean isNetworkRequired()
```
  - isUnmeteredNetworkRequired
```
public boolean isUnmeteredNetworkRequired()
```

Class Params

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FOREVER

NEVER

Constructor Detail

Params

Method Detail

requireNetwork

requireUnmeteredNetwork

groupBy

singleInstanceBy

persist

delayInMs

setRequiresNetwork

setRequiresUnmeteredNetwork

setGroupId

setSingleId

setPersistent

setDelayMs

addTags

removeTags

clearTags

overrideDeadlineToRunInMs

overrideDeadlineToCancelInMs

getGroupId

getSingleId

isPersistent

getPriority

getDelayMs

getDeadlineMs

getCancelOnDeadline

getTags

shouldCancelOnDeadline

isNetworkRequired

isUnmeteredNetworkRequired