LocalCampaignsModule (sdk 1.18.1 API)

java.lang.Object
- com.batch.android.module.BatchModule
- - com.batch.android.module.LocalCampaignsModule

public class LocalCampaignsModule
extends BatchModule

Batch's Local Campaigns Messaging Module.

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String TAG

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`batchDidStart()`	Called by Batch right after batch start NB : Same context and activity that in willStart but with the new state `State.READY` set
`void`	`batchDidStop()`	Called by Batch right after batch stop NB : No context or activity are available
`java.lang.String`	`getId()`	ID of the module
`int`	`getState()`	Should return the state of the module (usually 0 for deactivated, 1 for activated)
`static LocalCampaignsModule`	`provide()`
`void`	`sendSignal(Signal signal)`
`void`	`wipeData(android.content.Context context)`

Methods inherited from class com.batch.android.module.BatchModule
batchIsFinishing, batchWillStart, batchWillStop

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

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    
    Constant Field Values
- Method Detail
  - provide
```
public static LocalCampaignsModule provide()
```
  - getId
```
public java.lang.String getId()
```
    Description copied from class: BatchModule
    
    ID of the module
    
    Specified by:
    
    getId in class BatchModule
    
    Returns:
  - getState
```
public int getState()
```
    Description copied from class: BatchModule
    
    Should return the state of the module (usually 0 for deactivated, 1 for activated)
    
    Specified by:
    
    getState in class BatchModule
    
    Returns:
  - sendSignal
```
public void sendSignal(@NonNull
                       Signal signal)
```
  - wipeData
```
public void wipeData(@NonNull
                     android.content.Context context)
```
  - batchDidStart
```
public void batchDidStart()
```
    Description copied from class: BatchModule
    
    Called by Batch right after batch start
    NB : Same context and activity that in willStart but with the new state State.READY set
    
    Overrides:
    
    batchDidStart in class BatchModule
  - batchDidStop
```
public void batchDidStop()
```
    Description copied from class: BatchModule
    
    Called by Batch right after batch stop
    NB : No context or activity are available
    
    Overrides:
    
    batchDidStop in class BatchModule