com.braze.models.inappmessage

Interface IInAppMessageImmersive

All Superinterfaces:

IInAppMessage, IPutIntoJson<org.json.JSONObject>

All Known Implementing Classes:

InAppMessageFull, InAppMessageImmersiveBase, InAppMessageModal

public interface IInAppMessageImmersive
extends IInAppMessage

InAppMessageBase is the base model interface for all immersive in-app messages.

An immersive in-app message is defined as an in-app message that takes up the entire screen and/or 'blocks' the user from interacting with the app until the message is dismissed. Immersive messages extend the base in-app message with header text, message buttons, and a close button.

All Known Implementing Classes: InAppMessageImmersiveBase InAppMessageModal InAppMessageFull

Method Summary

Modifier and Type	Method and Description
int	getCloseButtonColor() Gets the close button color on this in-app message.
java.lang.Integer	getFrameColor() Gets the frame color for this in-app message.
java.lang.String	getHeader() Gets the header text on this in-app message.
TextAlign	getHeaderTextAlign() Get the text alignment for the header text.
int	getHeaderTextColor() Gets the header text color on this in-app message.
ImageStyle	getImageStyle() Get the image style on this in-app message.
java.util.List<MessageButton>	getMessageButtons() Gets the message buttons for this in-app message.
boolean	logButtonClick(MessageButton messageButton) Logs a click on this message button.
void	setCloseButtonColor(int closeButtonColor) Sets the close button color on this in-app message.
void	setFrameColor(java.lang.Integer frameColor) Sets the frame color for this in-app message.
void	setHeader(java.lang.String header) Sets the header text of this in-app message.
void	setHeaderTextAlign(TextAlign textAlign) Set the text alignment for the header text.
void	setHeaderTextColor(int headerTextColor) Sets the header text color on this in-app message.
void	setImageStyle(ImageStyle imageStyle) Set the image style on this in-app message.
void	setMessageButtons(java.util.List<MessageButton> messageButtons) Sets the message buttons for this in-app message.

Methods inherited from interface com.braze.models.inappmessage.IInAppMessage

getAnimateIn, getAnimateOut, getBackgroundColor, getClickAction, getCropType, getDismissType, getDurationInMilliseconds, getExpirationTimestamp, getExtras, getIcon, getIconBackgroundColor, getIconColor, getLocalPrefetchedAssetPaths, getMessage, getMessageTextAlign, getMessageTextColor, getMessageType, getOpenUriInWebView, getOrientation, getRemoteAssetPathsForPrefetch, getUri, isControl, logClick, logDisplayFailure, logImpression, onAfterClosed, setAnimateIn, setAnimateOut, setBackgroundColor, setClickAction, setClickAction, setCropType, setDismissType, setDurationInMilliseconds, setExpirationTimestamp, setExtras, setIcon, setIconBackgroundColor, setIconColor, setLocalPrefetchedAssetPaths, setMessage, setMessageTextAlign, setMessageTextColor, setOpenUriInWebView, setOrientation

Methods inherited from interface com.braze.models.IPutIntoJson

forJsonPut

Method Detail

getHeader

java.lang.String getHeader()

Gets the header text on this in-app message.

Returns:

the header text on this in-app message.

getHeaderTextColor

int getHeaderTextColor()

Gets the header text color on this in-app message.

Returns:

See Color

getCloseButtonColor

int getCloseButtonColor()

Gets the close button color on this in-app message.

Returns:

See Color

getMessageButtons

java.util.List<MessageButton> getMessageButtons()

Gets the message buttons for this in-app message.

See MessageButton.

Returns:

a non-null list of message buttons on this in-app message. If no buttons are set, this list will be empty.

getFrameColor

java.lang.Integer getFrameColor()

Gets the frame color for this in-app message. The frame refers to the area surrounding a modal in-app message.

Returns:

the frame color for this in-app message, or null if the default should be used.

getImageStyle

ImageStyle getImageStyle()

Get the image style on this in-app message.

Returns:

the image style for this in-app message

getHeaderTextAlign

TextAlign getHeaderTextAlign()

Get the text alignment for the header text.

Returns:

the text alignment for the header text

setHeaderTextAlign

void setHeaderTextAlign(TextAlign textAlign)

Set the text alignment for the header text.

Parameters:

textAlign - the text alignment for the header text

setImageStyle

void setImageStyle(ImageStyle imageStyle)

Set the image style on this in-app message.

Parameters:

imageStyle - the image style for this in-app message

setFrameColor

void setFrameColor(java.lang.Integer frameColor)

Sets the frame color for this in-app message. The frame refers to the area surrounding a modal in-app message.

Parameters:

frameColor - the desired frame color, or null if the default should be used.

setMessageButtons

void setMessageButtons(java.util.List<MessageButton> messageButtons)

Sets the message buttons for this in-app message.

See MessageButton

Parameters:

messageButtons - list of message buttons for this in-app message.

setHeader

void setHeader(java.lang.String header)

Sets the header text of this in-app message.

Parameters:

header - the desired header text for this in-app message.

setHeaderTextColor

void setHeaderTextColor(int headerTextColor)

Sets the header text color on this in-app message.

Parameters:

headerTextColor - See Color

setCloseButtonColor

void setCloseButtonColor(int closeButtonColor)

Sets the close button color on this in-app message.

Parameters:

closeButtonColor - See Color

logButtonClick

boolean logButtonClick(MessageButton messageButton)

Logs a click on this message button.

Message button clicks may only be logged once per in-app message before requiring a reset to re-enable logging. To log multiple clicks to the same IInAppMessage, for example, when the same IInAppMessage instance is used to back multiple in-app messages shown to the user, use #resetAnalytics()

See IInAppMessage.logClick() See MessageButton

Returns:

true iff the click was successfully logged.