com.braze.ui.inappmessage.listeners

Interface IInAppMessageManagerListener

All Known Implementing Classes:

DefaultInAppMessageManagerListener

public interface IInAppMessageManagerListener

The IInAppMessageManagerListener returns the in-app message at specific events in its control flow and gives the host app the option of overriding Braze's default display handling and implementing its own custom behavior.

If you are implementing Unity, you must use IAppboyUnityInAppMessageListener instead.

See BrazeInAppMessageManager

Method Summary

Modifier and Type	Method and Description
void	afterInAppMessageViewClosed(IInAppMessage inAppMessage) Called after the in-app message View has been removed from the layout (and the disappearing animation has completed).
void	afterInAppMessageViewOpened(android.view.View inAppMessageView, IInAppMessage inAppMessage) Called after the in-app message View has been added to the layout (and the appearing animation has completed).
InAppMessageOperation	beforeInAppMessageDisplayed(IInAppMessage inAppMessage)
void	beforeInAppMessageViewClosed(android.view.View inAppMessageView, IInAppMessage inAppMessage) Called before the in-app message View is removed from the layout (and before any closing animation starts).
void	beforeInAppMessageViewOpened(android.view.View inAppMessageView, IInAppMessage inAppMessage) Called before the in-app message View is added to the layout.
boolean	onInAppMessageButtonClicked(IInAppMessage inAppMessage, MessageButton button, InAppMessageCloser inAppMessageCloser)
boolean	onInAppMessageClicked(IInAppMessage inAppMessage, InAppMessageCloser inAppMessageCloser)
void	onInAppMessageDismissed(IInAppMessage inAppMessage)

Method Detail

beforeInAppMessageDisplayed

InAppMessageOperation beforeInAppMessageDisplayed(IInAppMessage inAppMessage)

Parameters:

inAppMessage - The in-app message that is currently requested for display.

Returns:

InAppMessageOperation indicating how to handle the candidate in-app message.

onInAppMessageClicked

boolean onInAppMessageClicked(IInAppMessage inAppMessage,
                              InAppMessageCloser inAppMessageCloser)

Parameters:

inAppMessage - The clicked in-app message.

inAppMessageCloser - Closing should not be animated if transitioning to a new activity. If remaining in the same activity, closing should be animated.

Returns:

boolean flag to indicate to Braze whether the click has been manually handled. If true, Braze will only log a click and do nothing else. If false, Braze will log a click and also close the in-app message automatically.

onInAppMessageButtonClicked

boolean onInAppMessageButtonClicked(IInAppMessage inAppMessage,
                                    MessageButton button,
                                    InAppMessageCloser inAppMessageCloser)

Parameters:

inAppMessage - The clicked in-app message.

button - The clicked message button.

inAppMessageCloser - Closing should not be animated if transitioning to a new activity. If remaining in the same activity, closing should be animated.

Returns:

boolean flag to indicate to Braze whether the click has been manually handled. If true, Braze will only log a click and do nothing else. If false, Braze will log a click and also close the in-app message automatically.

onInAppMessageDismissed

void onInAppMessageDismissed(IInAppMessage inAppMessage)

Parameters:

inAppMessage - the in-app message that was closed.

beforeInAppMessageViewOpened

void beforeInAppMessageViewOpened(android.view.View inAppMessageView,
                                  IInAppMessage inAppMessage)

Called before the in-app message View is added to the layout.

Note that this is called before any default processing in DefaultInAppMessageViewLifecycleListener takes place.

Parameters:

inAppMessageView - The View representing the IInAppMessage.

inAppMessage - The IInAppMessage being displayed.

afterInAppMessageViewOpened

void afterInAppMessageViewOpened(android.view.View inAppMessageView,
                                 IInAppMessage inAppMessage)

Called after the in-app message View has been added to the layout (and the appearing animation has completed).

Note that this is called after any default processing in DefaultInAppMessageViewLifecycleListener takes place.

Parameters:

inAppMessageView - The View representing the IInAppMessage.

inAppMessage - The IInAppMessage being displayed.

beforeInAppMessageViewClosed

void beforeInAppMessageViewClosed(android.view.View inAppMessageView,
                                  IInAppMessage inAppMessage)

Called before the in-app message View is removed from the layout (and before any closing animation starts).

Note that this is called before any default processing in DefaultInAppMessageViewLifecycleListener takes place.

Parameters:

inAppMessageView - The View representing the IInAppMessage.

inAppMessage - The IInAppMessage being displayed.

afterInAppMessageViewClosed

void afterInAppMessageViewClosed(IInAppMessage inAppMessage)

Called after the in-app message View has been removed from the layout (and the disappearing animation has completed).

Note that this is called after any default processing in DefaultInAppMessageViewLifecycleListener takes place.

Parameters:

inAppMessage - The IInAppMessage being displayed.