Package com.batch.android.module

Class OptOutModule

java.lang.Object

com.batch.android.module.BatchModule

com.batch.android.module.OptOutModule

public class OptOutModule
extends BatchModule

Batch's Opt Out Module.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	INTENT_OPTED_IN
static java.lang.String	INTENT_OPTED_OUT
static java.lang.String	INTENT_OPTED_OUT_WIPE_DATA_EXTRA
static java.lang.String	TAG

Constructor Summary

Constructors

Constructor	Description
OptOutModule()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getId()	ID of the module
int	getState()	Should return the state of the module (usually 0 for deactivated, 1 for activated)
java.lang.Boolean	isOptedOut()
boolean	isOptedOutSync(android.content.Context context)
void	optIn(android.content.Context context)
Promise<java.lang.Void>	optOut(android.content.Context context, AdvertisingID advertisingID, boolean wipeData, BatchOptOutResultListener listener)
void	trackOptinEventIfNeeded(android.content.Context context, AdvertisingID advertisingID)
void	wipeData(android.content.Context context)

Methods inherited from class com.batch.android.module.BatchModule

batchContextBecameAvailable, batchDidStart, batchDidStop, 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

INTENT_OPTED_OUT

public static final java.lang.String INTENT_OPTED_OUT

See Also:

Constant Field Values

INTENT_OPTED_IN

public static final java.lang.String INTENT_OPTED_IN

See Also:

Constant Field Values

INTENT_OPTED_OUT_WIPE_DATA_EXTRA

public static final java.lang.String INTENT_OPTED_OUT_WIPE_DATA_EXTRA

See Also:

Constant Field Values

Constructor Detail

OptOutModule

public OptOutModule()

Method Detail

isOptedOut

public java.lang.Boolean isOptedOut()

isOptedOutSync

public boolean isOptedOutSync(android.content.Context context)

trackOptinEventIfNeeded

public void trackOptinEventIfNeeded(@NonNull
                                    android.content.Context context,
                                    @NonNull
                                    AdvertisingID advertisingID)

optIn

public void optIn(android.content.Context context)

optOut

public Promise<java.lang.Void> optOut(android.content.Context context,
                                      AdvertisingID advertisingID,
                                      boolean wipeData,
                                      BatchOptOutResultListener listener)

wipeData

public void wipeData(android.content.Context context)

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: