braze-android-sdk/com.braze.ui.inappmessage/DefaultInAppMessageViewWrapper

DefaultInAppMessageViewWrapper

open class DefaultInAppMessageViewWrapper @JvmOverloads constructor(val inAppMessageView: View, val inAppMessage: IInAppMessage, val inAppMessageViewLifecycleListener: IInAppMessageViewLifecycleListener, val configurationProvider: BrazeConfigurationProvider, val openingAnimation: Animation?, val closingAnimation: Animation?, var clickableInAppMessageView: View?, var buttonViews: List<View>? = null, var closeButton: View? = null) : IInAppMessageViewWrapper

Constructor for base and slideup view wrappers. Adds click listeners to the in-app message view and adds swipe functionality to slideup in-app messages.

Parameters

inAppMessageView

In-app message top level view.

inAppMessage

In-app message model.

inAppMessageViewLifecycleListener

In-app message lifecycle listener.

configurationProvider

Configuration provider.

clickableInAppMessageView

View for which click actions apply.

buttonViews

List of views corresponding to MessageButton objects stored in the in-app message model object. These views should map one to one with the MessageButton objects.

closeButton

The View responsible for closing the in-app message.

Constructors

DefaultInAppMessageViewWrapper

@JvmOverloads

fun DefaultInAppMessageViewWrapper(inAppMessageView: View, inAppMessage: IInAppMessage, inAppMessageViewLifecycleListener: IInAppMessageViewLifecycleListener, configurationProvider: BrazeConfigurationProvider, openingAnimation: Animation?, closingAnimation: Animation?, clickableInAppMessageView: View?, buttonViews: List<View>? = null, closeButton: View? = null)

Types

Companion

object Companion

Functions

addDismissRunnable

open fun addDismissRunnable()

addInAppMessageViewToViewGroup

open fun addInAppMessageViewToViewGroup(parentViewGroup: ViewGroup, inAppMessage: IInAppMessage, inAppMessageView: View, inAppMessageViewLifecycleListener: IInAppMessageViewLifecycleListener)

Adds the IInAppMessageView to the parent ViewGroup. Also calls IInAppMessageViewLifecycleListener.beforeOpened and IInAppMessageViewLifecycleListener.afterOpened.

announceForAccessibilityIfNecessary

open fun announceForAccessibilityIfNecessary(fallbackAccessibilityMessage: String? = "In app message displayed.")

Calls View.announceForAccessibility with the IInAppMessage.getMessage if the IInAppMessageView is IInAppMessageImmersiveView or the fallback message IInAppMessageView is a InAppMessageHtmlBaseView.

open override fun close()

Closes an IInAppMessage. As a result of this call, it is expected that an IInAppMessage is no longer visible and not interactable by the user.

closeInAppMessageView

open fun closeInAppMessageView()

Closes the in-app message view. In this order, the following actions are performed:

createAnimationListener

open fun createAnimationListener(opening: Boolean): Animation.AnimationListener

createButtonClickListener

open fun createButtonClickListener(): View.OnClickListener

createClickListener

open fun createClickListener(): View.OnClickListener

Creates a View.OnClickListener that calls IInAppMessageViewLifecycleListener.onClicked.

createCloseInAppMessageClickListener

open fun createCloseInAppMessageClickListener(): View.OnClickListener

createDismissCallbacks

open fun createDismissCallbacks(): SwipeDismissTouchListener.DismissCallbacks

createTouchAwareListener

open fun createTouchAwareListener(): TouchAwareSwipeDismissTouchListener.ITouchListener

finalizeViewBeforeDisplay

open fun finalizeViewBeforeDisplay(inAppMessage: IInAppMessage, inAppMessageView: View, inAppMessageViewLifecycleListener: IInAppMessageViewLifecycleListener)

Performs any last actions before calling IInAppMessageViewLifecycleListener.beforeOpened.

getLayoutParams

open fun getLayoutParams(inAppMessage: IInAppMessage?): ViewGroup.LayoutParams

Creates the ViewGroup.LayoutParams used for adding the IInAppMessageView to the ViewGroup returned by DefaultInAppMessageViewWrapper.getParentViewGroup.

getParentViewGroup

open fun getParentViewGroup(activity: Activity): ViewGroup

Gets the ViewGroup which will display the in-app message. Note that if this implementation is overridden, then DefaultInAppMessageViewWrapper.getLayoutParams should also most likely be overridden to match the ViewGroup subclass returned here.

open

open override fun open(activity: Activity)

Opens an IInAppMessage on the Activity. As a result of this call, it is expected that an IInAppMessage is visible and interactable by the user.

setAndStartAnimation

open fun setAndStartAnimation(opening: Boolean)

Instantiates and executes the correct animation for the current in-app message. Slideup-type messages slide in from the top or bottom of the view. Other in-app messages fade in and out of view.