com.braze.ui.inappmessage.views

Interface IInAppMessageView

All Known Subinterfaces:

IInAppMessageImmersiveView, IInAppMessageView

All Known Implementing Classes:

AppboyInAppMessageBaseView, AppboyInAppMessageFullView, AppboyInAppMessageHtmlBaseView, AppboyInAppMessageHtmlFullView, AppboyInAppMessageHtmlView, AppboyInAppMessageImmersiveBaseView, AppboyInAppMessageModalView, AppboyInAppMessageSlideupView, InAppMessageBaseView, InAppMessageFullView, InAppMessageHtmlBaseView, InAppMessageHtmlFullView, InAppMessageHtmlView, InAppMessageImmersiveBaseView, InAppMessageModalView, InAppMessageSlideupView

public interface IInAppMessageView

IInAppMessageView is the base view interface for all in-app messages.

Method Summary

Modifier and Type	Method and Description
void	applyWindowInsets(WindowInsetsCompat insets) Called when the WindowInsetsCompat information should be applied to this in-app message.
android.view.View	getMessageClickableView() Gets the clickable portion of the in-app message so that Braze can add click listeners to it.
boolean	hasAppliedWindowInsets() Helper method to prevent WindowInsetsCompat from getting applied multiple times on the same in-app message view.

Method Detail

getMessageClickableView

android.view.View getMessageClickableView()

Gets the clickable portion of the in-app message so that Braze can add click listeners to it.

Returns:

the View that displays the clickable portion of the in-app message. If the entire message is clickable, return this.

applyWindowInsets

void applyWindowInsets(WindowInsetsCompat insets)

Called when the WindowInsetsCompat information should be applied to this in-app message. WindowInsetsCompat will typically only be applied on notched devices and on Activities displaying inside the screen cutout area.

Implementations of this method are expected to modify any necessary margins to ensure compatibility with the argument notch dimensions. For example, full screen in-app messages should have their close buttons moved to not be obscured by the status bar, slideups should not render behind the notch, and modal in-app messages will have no changes since they do not render in the cutout area.

The screen has a notch if WindowInsetsCompat#getDisplayCutout() is non-null. The system window insets (e.g. WindowInsetsCompat#getSystemWindowInsetTop() will be present if the status bar is translucent or the status/navigation bars are otherwise non-occluding of the root Activity content.

Parameters:

insets - The WindowInsetsCompat object directly from androidx.core.view.ViewCompat#setOnApplyWindowInsetsListener(View, OnApplyWindowInsetsListener).

hasAppliedWindowInsets

boolean hasAppliedWindowInsets()

Helper method to prevent WindowInsetsCompat from getting applied multiple times on the same in-app message view.

Returns:

Whether WindowInsetsCompat has been applied to this in-app message.

See Also:

applyWindowInsets(WindowInsetsCompat)