Package com.batch.android.module

Class MessagingModule

java.lang.Object

com.batch.android.module.BatchModule

com.batch.android.module.MessagingModule

public class MessagingModule
extends BatchModule

Batch's Messaging Module.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ACTION_DISMISS_BANNER	Broadcast this action using LocalBroadcastManager and banners will dismiss themselves
static java.lang.String	ACTION_DISMISS_INTERSTITIAL	Broadcast this action using LocalBroadcastManager and MessagingActivity instances will dismiss themselves
static double	DEFAULT_IMAGE_DOWNLOAD_TIMEOUT
static java.lang.String	TAG

Method Summary

Modifier and Type	Method	Description
void	displayInAppMessage(BatchInAppMessage message)
void	displayMessage(android.content.Context context, BatchMessage message, boolean bypassDnD)
boolean	doesAppHaveRequiredLibraries(boolean logErrors)
java.lang.String	getId()	ID of the module
Batch.Messaging.LifecycleListener	getListener()
int	getState()	Should return the state of the module (usually 0 for deactivated, 1 for activated)
boolean	hasPendingMessage()
boolean	isDoNotDisturbEnabled()
boolean	isInAutomaticMode()
BatchBannerView	loadBanner(android.content.Context context, BatchMessage payloadMessage, JSONObject json)
androidx.fragment.app.DialogFragment	loadFragment(android.content.Context context, BatchMessage payloadMessage, JSONObject json)
void	onMessageAutoClosed(Message message)
void	onMessageClosed(Message message)
void	onMessageClosedError(Message message, MessagingError cause)
void	onMessageCTAClicked(Message message, int ctaIndex, CTA cta)
void	onMessageDismissed(Message message)
void	onMessageGlobalTap(Message message, Action action)
void	onMessageShown(Message message)
void	onWebViewMessageClickTracked(Message message, Action action, java.lang.String buttonAnalyticsId)
void	performAction(android.content.Context c, BatchMessage payloadMessage, Action a)
BatchMessage	popPendingMessage()
static MessagingModule	provide()
void	setAutomaticMode(boolean automatic)
void	setDoNotDisturbEnabled(boolean enableDnd)
void	setLifecycleListener(Batch.Messaging.LifecycleListener listener)
void	setShowForegroundLandings(boolean showForegroundLandings)
void	setTypefaceOverride(android.graphics.Typeface normalTypeface, android.graphics.Typeface boldTypeface)
boolean	shouldShowForegroundLandings()

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

ACTION_DISMISS_INTERSTITIAL

public static final java.lang.String ACTION_DISMISS_INTERSTITIAL

Broadcast this action using LocalBroadcastManager and MessagingActivity instances will dismiss themselves

See Also:

Constant Field Values

ACTION_DISMISS_BANNER

public static final java.lang.String ACTION_DISMISS_BANNER

Broadcast this action using LocalBroadcastManager and banners will dismiss themselves

See Also:

Constant Field Values

DEFAULT_IMAGE_DOWNLOAD_TIMEOUT

public static final double DEFAULT_IMAGE_DOWNLOAD_TIMEOUT

See Also:

Constant Field Values

Method Detail

provide

public static MessagingModule 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:

shouldShowForegroundLandings

public boolean shouldShowForegroundLandings()

isInAutomaticMode

public boolean isInAutomaticMode()

getListener

public Batch.Messaging.LifecycleListener getListener()

isDoNotDisturbEnabled

public boolean isDoNotDisturbEnabled()

setShowForegroundLandings

public void setShowForegroundLandings(boolean showForegroundLandings)

setAutomaticMode

public void setAutomaticMode(boolean automatic)

setTypefaceOverride

public void setTypefaceOverride(@Nullable
                                android.graphics.Typeface normalTypeface,
                                @Nullable
                                android.graphics.Typeface boldTypeface)

setLifecycleListener

public void setLifecycleListener(Batch.Messaging.LifecycleListener listener)

setDoNotDisturbEnabled

public void setDoNotDisturbEnabled(boolean enableDnd)

hasPendingMessage

public boolean hasPendingMessage()

popPendingMessage

@Nullable
public BatchMessage popPendingMessage()

doesAppHaveRequiredLibraries

public boolean doesAppHaveRequiredLibraries(boolean logErrors)

loadFragment

public androidx.fragment.app.DialogFragment loadFragment(@NonNull
                                                         android.content.Context context,
                                                         @NonNull
                                                         BatchMessage payloadMessage,
                                                         @NonNull
                                                         JSONObject json)
                                                  throws BatchMessagingException

Throws:

BatchMessagingException

loadBanner

public BatchBannerView loadBanner(@NonNull
                                  android.content.Context context,
                                  @NonNull
                                  BatchMessage payloadMessage,
                                  @NonNull
                                  JSONObject json)
                           throws BatchMessagingException

Throws:

BatchMessagingException

performAction

public void performAction(android.content.Context c,
                          BatchMessage payloadMessage,
                          Action a)

displayMessage

public void displayMessage(@NonNull
                           android.content.Context context,
                           @NonNull
                           BatchMessage message,
                           boolean bypassDnD)

displayInAppMessage

public void displayInAppMessage(@NonNull
                                BatchInAppMessage message)

onMessageShown

public void onMessageShown(@NonNull
                           Message message)

onMessageDismissed

public void onMessageDismissed(@NonNull
                               Message message)

onMessageClosed

public void onMessageClosed(@NonNull
                            Message message)

onMessageCTAClicked

public void onMessageCTAClicked(@NonNull
                                Message message,
                                int ctaIndex,
                                @NonNull
                                CTA cta)

onWebViewMessageClickTracked

public void onWebViewMessageClickTracked(@NonNull
                                         Message message,
                                         @NonNull
                                         Action action,
                                         @Nullable
                                         java.lang.String buttonAnalyticsId)

onMessageGlobalTap

public void onMessageGlobalTap(@NonNull
                               Message message,
                               @NonNull
                               Action action)

onMessageAutoClosed

public void onMessageAutoClosed(@NonNull
                                Message message)

onMessageClosedError

public void onMessageClosedError(@NonNull
                                 Message message,
                                 @NonNull
                                 MessagingError cause)