com.braze.ui.inappmessage

Class InAppMessageManagerBase

java.lang.Object

com.braze.ui.inappmessage.InAppMessageManagerBase

Direct Known Subclasses:

BrazeInAppMessageManager

public class InAppMessageManagerBase
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
InAppMessageManagerBase()

Method Summary

Modifier and Type	Method and Description
android.app.Activity	getActivity()
android.content.Context	getApplicationContext()
IInAppMessageManagerListener	getControlInAppMessageManagerListener() A IInAppMessageManagerListener to be used only for control in-app messages.
IInAppMessageViewFactory	getDefaultInAppMessageViewFactory(IInAppMessage inAppMessage) Gets the default IInAppMessageViewFactory as returned by the BrazeInAppMessageManager for the given IInAppMessage.
boolean	getDoesBackButtonDismissInAppMessageView()
boolean	getDoesClickOutsideModalViewDismissInAppMessageView()
IHtmlInAppMessageActionListener	getHtmlInAppMessageActionListener()
IInAppMessageAnimationFactory	getInAppMessageAnimationFactory()
IInAppMessageManagerListener	getInAppMessageManagerListener()
IInAppMessageViewFactory	getInAppMessageViewFactory(IInAppMessage inAppMessage)
IInAppMessageViewWrapperFactory	getInAppMessageViewWrapperFactory()
void	setBackButtonDismissesInAppMessageView(boolean backButtonDismissesInAppMessageView) Sets whether the hardware back button dismisses in-app messages.
void	setClickOutsideModalViewDismissInAppMessageView(boolean doesDismiss) Sets whether the tapping outside the modal in-app message content dismiss the message.
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	setCustomInAppMessageViewWrapperFactory(IInAppMessageViewWrapperFactory inAppMessageViewWrapperFactory) Sets a custom IInAppMessageViewWrapperFactory that will be used to display an IInAppMessage to the user.

Methods inherited from class java.lang.Object

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

Constructor Detail

InAppMessageManagerBase

public InAppMessageManagerBase()

Method Detail

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()

getDefaultInAppMessageViewFactory

public IInAppMessageViewFactory getDefaultInAppMessageViewFactory(IInAppMessage inAppMessage)

Gets the default IInAppMessageViewFactory as returned by the BrazeInAppMessageManager for the given IInAppMessage.

Returns:

The IInAppMessageViewFactory or null if the message type does not have a IInAppMessageViewFactory.

getInAppMessageViewWrapperFactory

public IInAppMessageViewWrapperFactory getInAppMessageViewWrapperFactory()

getDoesBackButtonDismissInAppMessageView

public boolean getDoesBackButtonDismissInAppMessageView()

getDoesClickOutsideModalViewDismissInAppMessageView

public boolean getDoesClickOutsideModalViewDismissInAppMessageView()

getInAppMessageAnimationFactory

public IInAppMessageAnimationFactory getInAppMessageAnimationFactory()

getInAppMessageViewFactory

public IInAppMessageViewFactory getInAppMessageViewFactory(IInAppMessage inAppMessage)

getActivity

public android.app.Activity getActivity()

getApplicationContext

public android.content.Context getApplicationContext()

setBackButtonDismissesInAppMessageView

public void setBackButtonDismissesInAppMessageView(boolean backButtonDismissesInAppMessageView)

Sets whether the hardware back button dismisses in-app messages. Defaults to true. Note that the hardware back button default behavior will be used instead (i.e. the host Activity's Activity.onKeyDown(int, KeyEvent) method will be called).

setClickOutsideModalViewDismissInAppMessageView

public void setClickOutsideModalViewDismissInAppMessageView(boolean doesDismiss)

Sets whether the tapping outside the modal in-app message content dismiss the message. Defaults to false.

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 this 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 this 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).

setCustomInAppMessageViewWrapperFactory

public void setCustomInAppMessageViewWrapperFactory(IInAppMessageViewWrapperFactory inAppMessageViewWrapperFactory)

Sets a custom IInAppMessageViewWrapperFactory that will be used to display an IInAppMessage to the user.