com.braze.ui.inappmessage

Class BrazeInAppMessageManager

java.lang.Object

com.braze.ui.inappmessage.InAppMessageManagerBase

com.braze.ui.inappmessage.BrazeInAppMessageManager

public class BrazeInAppMessageManager
extends InAppMessageManagerBase

This class is used to display in-app messages that are either sent from Braze or are created natively in the host app. It will only show one in-app message at a time and will place all other in-app messages onto a stack. The BrazeInAppMessageManager will also keep track of in-app impressions and clicks, which can be viewed on the dashboard.

When an in-app message is received from Braze, the IInAppMessageManagerListener#onInAppMessageReceived(IInAppMessage) method is called (if set). If this method returns true, that signals to the BrazeInAppMessageManager that the in-app message will be handled by the host app and that it should not be displayed by the BrazeInAppMessageManager. This method should be used if you choose to display the in-app message in a custom way. If false is returned, the BrazeInAppMessageManager attempts to display the in-app message.

If there is already an in-app message being displayed, the new in-app message will be put onto the top of the stack and can be displayed at a later time. If there is no in-app message being displayed, then the IInAppMessageManagerListener.beforeInAppMessageDisplayed(IInAppMessage) will be called. The InAppMessageOperation return value can be used to control when the in-app message should be displayed. A suggested usage of this method would be to delay in-app message messages in certain parts of the app by returning InAppMessageOperation.DISPLAY_LATER when in-app message would be distracting to the users app experience. If the method returns InAppMessageOperation.DISPLAY_NOW then the in-app message will be displayed immediately.

The IInAppMessageManagerListener.onInAppMessageClicked(IInAppMessage, InAppMessageCloser) and IInAppMessageManagerListener.onInAppMessageDismissed(IInAppMessage) methods can be used to override the default click and dismiss behavior.

By default, in-app messages fade in and out from view. The slideup type of in-app message slides in and out of view can be dismissed by swiping the view horizontally. If the in-app message's DismissType is set to AUTO_DISMISS, then the in-app message will animate out of view once the set duration time has elapsed.

In order to use a custom view, you must create a custom view factory using the InAppMessageManagerBase.setCustomInAppMessageViewFactory(IInAppMessageViewFactory inAppMessageViewFactory) method.

A new in-app message View object is created when a in-app message is displayed and also when the user navigates away to another Activity. This happens so that the Activity can be garbage collected and does not create a memory leak. For that reason, the registerInAppMessageManager(android.app.Activity) and unregisterInAppMessageManager(android.app.Activity) must be called in the Activity.onResume() and Activity.onPause() methods of every Activity.

Constructor Summary

Constructors

Constructor and Description
BrazeInAppMessageManager()

Method Summary

Modifier and Type	Method and Description
void	addInAppMessage(IInAppMessage inAppMessage) Provides a in-app message that will then be handled by the in-app message manager.
void	displayInAppMessage(IInAppMessage inAppMessage, boolean isCarryOver) Internal method, do not call as part of an integration! Attempts to display an IInAppMessage to the user.
void	ensureSubscribedToInAppMessageEvents(android.content.Context context) Ensures the InAppMessageManager is subscribed in-app message events if not already subscribed.
IInAppMessage	getCarryoverInAppMessage() An In-App Message being carried over during the unregisterInAppMessageManager(Activity) registerInAppMessageManager(Activity) transition.
java.util.Stack<IInAppMessage>	getInAppMessageStack() The stack of In-App Messages waiting to be displayed.
static BrazeInAppMessageManager	getInstance()
boolean	getIsCurrentlyDisplayingInAppMessage() Gets whether an in-app message is currently displaying on the device.
IInAppMessage	getUnregisteredInAppMessage() An In-App Message that could not display after a call to requestDisplayInAppMessage() due to no Activity being registered via registerInAppMessageManager(Activity)
void	hideCurrentlyDisplayingInAppMessage(boolean dismissed) Hides any currently displaying in-app message.
void	registerInAppMessageManager(android.app.Activity activity) Registers the in-app message manager, which will listen to and display incoming in-app messages.
boolean	requestDisplayInAppMessage() Asks the InAppMessageManager to display the next in-app message if one is not currently being displayed.
void	resetAfterInAppMessageClose() Resets the BrazeInAppMessageManager to its original state before the last in-app message was displayed.
void	unregisterInAppMessageManager(android.app.Activity activity) Unregisters the in-app message manager.

Methods inherited from class com.braze.ui.inappmessage.InAppMessageManagerBase

getActivity, getApplicationContext, getControlInAppMessageManagerListener, getDefaultInAppMessageViewFactory, getDoesBackButtonDismissInAppMessageView, getDoesClickOutsideModalViewDismissInAppMessageView, getHtmlInAppMessageActionListener, getInAppMessageAnimationFactory, getInAppMessageManagerListener, getInAppMessageViewFactory, getInAppMessageViewWrapperFactory, setBackButtonDismissesInAppMessageView, setClickOutsideModalViewDismissInAppMessageView, setCustomControlInAppMessageManagerListener, setCustomHtmlInAppMessageActionListener, setCustomInAppMessageAnimationFactory, setCustomInAppMessageManagerListener, setCustomInAppMessageViewFactory, setCustomInAppMessageViewWrapperFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BrazeInAppMessageManager

public BrazeInAppMessageManager()

Method Detail

getInstance

public static BrazeInAppMessageManager getInstance()

ensureSubscribedToInAppMessageEvents

public void ensureSubscribedToInAppMessageEvents(android.content.Context context)

Ensures the InAppMessageManager is subscribed in-app message events if not already subscribed. Before this method gets called, the InAppMessageManager is not subscribed to in-app message events and cannot display them. Every call to registerInAppMessageManager() calls this method.

If events with triggers are logged before the first call to registerInAppMessageManager(), then the corresponding in-app message won't display. Thus, if logging events with triggers before the first call to registerInAppMessageManager(), then call this method to ensure that in-app message events are correctly handled by the BrazeInAppMessageManager.

For example, if logging custom events with triggers in your first activity's onCreate(), be sure to call this method manually beforehand so that the in-app message will get displayed by the time registerInAppMessageManager() gets called.

Parameters:

context - The application context

registerInAppMessageManager

public void registerInAppMessageManager(android.app.Activity activity)

Registers the in-app message manager, which will listen to and display incoming in-app messages. The current Activity is required in order to properly inflate and display the in-app message view.

Important note: Every Activity must call registerInAppMessageManager in the onResume lifecycle method, otherwise in-app messages may be lost!

This method also calls ensureSubscribedToInAppMessageEvents(Context). To be sure that no in-app messages are lost, you should call ensureSubscribedToInAppMessageEvents(Context) as early as possible in your app, preferably in your Application.onCreate().

Parameters:

activity - The current Activity.

unregisterInAppMessageManager

public void unregisterInAppMessageManager(android.app.Activity activity)

Unregisters the in-app message manager.

Parameters:

activity - The current Activity.

addInAppMessage

public void addInAppMessage(IInAppMessage inAppMessage)

Provides a in-app message that will then be handled by the in-app message manager. If no in-app message is being displayed, it will attempt to display the in-app message immediately.

Parameters:

inAppMessage - The in-app message to add.

requestDisplayInAppMessage

public boolean requestDisplayInAppMessage()

Asks the InAppMessageManager to display the next in-app message if one is not currently being displayed. If one is being displayed, this method will return false and will not display the next in-app message.

Returns:

A boolean value indicating whether an asynchronous task to display the in-app message display was executed.

hideCurrentlyDisplayingInAppMessage

public void hideCurrentlyDisplayingInAppMessage(boolean dismissed)

Hides any currently displaying in-app message. Note that in-app message animation is configurable on the in-app message model itself and should be configured there.

Parameters:

dismissed - whether the message was dismissed by the user. If dismissed is true, IInAppMessageViewLifecycleListener.onDismissed() will be called on the current IInAppMessageViewLifecycleListener.

resetAfterInAppMessageClose

public void resetAfterInAppMessageClose()

Resets the BrazeInAppMessageManager to its original state before the last in-app message was displayed. This allows for a new in-app message to be displayed after calling this method. ViewUtils.setActivityRequestedOrientation(Activity, int) is called with the original orientation before the last in-app message was displayed.

getIsCurrentlyDisplayingInAppMessage

public boolean getIsCurrentlyDisplayingInAppMessage()

Gets whether an in-app message is currently displaying on the device.

getInAppMessageStack

public java.util.Stack<IInAppMessage> getInAppMessageStack()

The stack of In-App Messages waiting to be displayed.

getCarryoverInAppMessage

public IInAppMessage getCarryoverInAppMessage()

An In-App Message being carried over during the unregisterInAppMessageManager(Activity) registerInAppMessageManager(Activity) transition.

getUnregisteredInAppMessage

public IInAppMessage getUnregisteredInAppMessage()

An In-App Message that could not display after a call to requestDisplayInAppMessage() due to no Activity being registered via registerInAppMessageManager(Activity)

displayInAppMessage

public void displayInAppMessage(IInAppMessage inAppMessage,
                                boolean isCarryOver)

Internal method, do not call as part of an integration!

Attempts to display an IInAppMessage to the user.

Parameters:

inAppMessage - The IInAppMessage.

isCarryOver - If this IInAppMessage is "carried over" from an Activity transition.