com.appboy.ui.inappmessage

Class AppboyInAppMessageManager

java.lang.Object

com.appboy.ui.inappmessage.AppboyInAppMessageManager

public final class AppboyInAppMessageManager
extends java.lang.Object

The AppboyInAppMessageManager is used to display in-app messages that are either sent down from Appboy 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 AppboyInAppMessageManager 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 Appboy, the IInAppMessageManagerListener.onInAppMessageReceived(com.appboy.models.IInAppMessage) method is called (if set). If this method returns true, that signals to the AppboyInAppMessageManager that the in-app message will be handled by the host app and that it should not be displayed by the AppboyInAppMessageManager. This method should be used if you choose to display the in-app message in a custom way. If false is returned, the AppboyInAppMessageManager 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(com.appboy.models.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(com.appboy.models.IInAppMessage, InAppMessageCloser) and IInAppMessageManagerListener.onInAppMessageDismissed(com.appboy.models.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.

The default view used to display slideup, modal, and full in-app messages is defined by res/layout/com_appboy_inappmessage_*.xml, where * is the message type. In order to use a custom view, you must create a custom view factory using the 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
AppboyInAppMessageManager()

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	ensureSubscribedToInAppMessageEvents(android.content.Context context) Ensures the InAppMessageManager is subscribed in-app message events if not already subscribed.
android.app.Activity	getActivity()
android.content.Context	getApplicationContext()
IInAppMessageManagerListener	getControlInAppMessageManagerListener() A IInAppMessageManagerListener to be used only for control in-app messages.
IHtmlInAppMessageActionListener	getHtmlInAppMessageActionListener()
IInAppMessageManagerListener	getInAppMessageManagerListener()
static AppboyInAppMessageManager	getInstance()
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()
void	setCustomControlInAppMessageManagerListener(IInAppMessageManagerListener inAppMessageManagerListener) Assigns a custom IInAppMessageManagerListener that will be used when displaying control in-app messages.
void	setCustomHtmlInAppMessageActionListener(IHtmlInAppMessageActionListener htmlInAppMessageActionListener) Assigns a custom IHtmlInAppMessageActionListener that will be used during the display of Html in-app messages.
void	setCustomInAppMessageAnimationFactory(IInAppMessageAnimationFactory inAppMessageAnimationFactory) Assigns a custom IInAppMessageAnimationFactory that will be used to animate the in-app message View.
void	setCustomInAppMessageManagerListener(IInAppMessageManagerListener inAppMessageManagerListener) Assigns a custom IInAppMessageManagerListener that will be used when displaying in-app messages.
void	setCustomInAppMessageViewFactory(IInAppMessageViewFactory inAppMessageViewFactory) Assigns a custom IInAppMessageViewFactory that will be used to create the in-app message View.
void	unregisterInAppMessageManager(android.app.Activity activity) Unregisters the in-app message manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppboyInAppMessageManager

public AppboyInAppMessageManager()

Method Detail

getInstance

public static AppboyInAppMessageManager 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 AppboyInAppMessageManager.

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.

setCustomInAppMessageManagerListener

public void setCustomInAppMessageManagerListener(IInAppMessageManagerListener inAppMessageManagerListener)

Assigns a custom IInAppMessageManagerListener that will be used when displaying in-app messages. To revert back to the default IInAppMessageManagerListener, call the setCustomInAppMessageManagerListener(IInAppMessageManagerListener) method with null.

see IInAppMessage.isControl()

Parameters:

inAppMessageManagerListener - A custom IInAppMessageManagerListener or null (to revert back to the default IInAppMessageManagerListener).

setCustomControlInAppMessageManagerListener

public void setCustomControlInAppMessageManagerListener(IInAppMessageManagerListener inAppMessageManagerListener)

Assigns a custom IInAppMessageManagerListener that will be used when displaying control in-app messages. To revert back to the default IInAppMessageManagerListener, call the setCustomControlInAppMessageManagerListener(IInAppMessageManagerListener) method with null.

Parameters:

inAppMessageManagerListener - A custom IInAppMessageManagerListener for control in-app messages or null (to revert back to the default IInAppMessageManagerListener).

setCustomHtmlInAppMessageActionListener

public void setCustomHtmlInAppMessageActionListener(IHtmlInAppMessageActionListener htmlInAppMessageActionListener)

Assigns a custom IHtmlInAppMessageActionListener that will be used during the display of Html in-app messages.

Parameters:

htmlInAppMessageActionListener - A custom IHtmlInAppMessageActionListener or null (to revert back to the default IHtmlInAppMessageActionListener).

setCustomInAppMessageAnimationFactory

public void setCustomInAppMessageAnimationFactory(IInAppMessageAnimationFactory inAppMessageAnimationFactory)

Assigns a custom IInAppMessageAnimationFactory that will be used to animate the in-app message View. To revert back to the default IInAppMessageAnimationFactory, call the setCustomInAppMessageAnimationFactory method with null.

Parameters:

inAppMessageAnimationFactory - A custom IInAppMessageAnimationFactory or null (to revert back to the default IInAppMessageAnimationFactory).

setCustomInAppMessageViewFactory

public void setCustomInAppMessageViewFactory(IInAppMessageViewFactory inAppMessageViewFactory)

Assigns a custom IInAppMessageViewFactory that will be used to create the in-app message View. To revert back to the default IInAppMessageViewFactory, call the setCustomInAppMessageViewFactory method with null.

Parameters:

inAppMessageViewFactory - A custom IInAppMessageViewFactory or null (to revert back to the default IInAppMessageViewFactory).

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.

getInAppMessageManagerListener

public IInAppMessageManagerListener getInAppMessageManagerListener()

getControlInAppMessageManagerListener

public IInAppMessageManagerListener getControlInAppMessageManagerListener()

A IInAppMessageManagerListener to be used only for control in-app messages.

see IInAppMessage.isControl()

getHtmlInAppMessageActionListener

public IHtmlInAppMessageActionListener getHtmlInAppMessageActionListener()

getActivity

public android.app.Activity getActivity()

getApplicationContext

public android.content.Context getApplicationContext()

resetAfterInAppMessageClose

public void resetAfterInAppMessageClose()