State (sdk 1.18.1 API)

java.lang.Object
- java.lang.Enum<State>
- - com.batch.android.runtime.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<State>
```
public enum State
extends java.lang.Enum<State>
```
State of the Batch lib

Enum Constant Summary

Enum Constants
Enum Constant	Description
`FINISHING`	The lib is finishing, no app listener or UI action must be called
`OFF`	The lib is off, no action should be performed since all context and storage are null
`READY`	The lib is ready for action

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static State`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static State[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OFF
```
public static final State OFF
```
    The lib is off, no action should be performed since all context and storage are null
  - READY
```
public static final State READY
```
    The lib is ready for action
  - FINISHING
```
public static final State FINISHING
```
    The lib is finishing, no app listener or UI action must be called
- Method Detail
  - values
```
public static State[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (State c : State.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static State valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null