com.braze.models.inappmessage

Class InAppMessageImmersiveBase

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

com.braze.models.inappmessage.InAppMessageWithImageBase

com.braze.models.inappmessage.InAppMessageImmersiveBase

All Implemented Interfaces:

IInAppMessage, IInAppMessageImmersive, IInAppMessageThemeable, IInAppMessageWithImage, IPutIntoJson<org.json.JSONObject>

Direct Known Subclasses:

InAppMessageFull, InAppMessageModal

public abstract class InAppMessageImmersiveBase
extends InAppMessageWithImageBase
implements IInAppMessageImmersive

Field Summary

Fields

Modifier and Type	Field and Description
protected ImageStyle	mImageStyle

Fields inherited from class com.braze.models.inappmessage.InAppMessageBase

ANIMATE_IN, ANIMATE_OUT, CROP_TYPE, INAPP_MESSAGE_DURATION_DEFAULT_MILLIS, INAPP_MESSAGE_DURATION_MIN_MILLIS, IS_CONTROL, mBrazeManager, mCropType, MESSAGE_TEXT_ALIGN, mInAppMessageDarkThemeWrapper, mJsonObject, mMessageTextAlign, mOpenUriInWebview, OPEN_URI_IN_WEBVIEW, TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InAppMessageImmersiveBase()
	InAppMessageImmersiveBase(org.json.JSONObject object, IBrazeManager appboyManager)

Method Summary

Modifier and Type	Method and Description
void	enableDarkTheme() Instructs the IInAppMessage to apply any dark theme settings and override any existing values present on the IInAppMessage.
org.json.JSONObject	forJsonPut() Storing in-app messages serialized with this method is primarily for storage as triggered actions.
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	onAfterClosed() Should be called on the in-app message once it is no longer being displayed, to allow it to perform any cleanup or trigger further actions.
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 class com.braze.models.inappmessage.InAppMessageWithImageBase

getBitmap, getImageDownloadSuccessful, getImageUrl, getLocalImageUrl, getRemoteAssetPathsForPrefetch, getRemoteImageUrl, setBitmap, setImageDownloadSuccessful, setImageUrl, setLocalImageUrl, setLocalPrefetchedAssetPaths, setRemoteImageUrl

Methods inherited from class com.braze.models.inappmessage.InAppMessageBase

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

Methods inherited from class java.lang.Object

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

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, setAnimateIn, setAnimateOut, setBackgroundColor, setClickAction, setClickAction, setCropType, setDismissType, setDurationInMilliseconds, setExpirationTimestamp, setExtras, setIcon, setIconBackgroundColor, setIconColor, setLocalPrefetchedAssetPaths, setMessage, setMessageTextAlign, setMessageTextColor, setOpenUriInWebView, setOrientation

Field Detail

mImageStyle

protected ImageStyle mImageStyle

Constructor Detail

InAppMessageImmersiveBase

protected InAppMessageImmersiveBase()

InAppMessageImmersiveBase

public InAppMessageImmersiveBase(org.json.JSONObject object,
                                 IBrazeManager appboyManager)
                          throws org.json.JSONException

Throws:

org.json.JSONException - if any fields are missing or the message is empty. Constructed InAppMessageImmersive objects are meant to be fully verified and good to go.

Method Detail

getHeader

public java.lang.String getHeader()

Description copied from interface: IInAppMessageImmersive

Gets the header text on this in-app message.

Specified by:

getHeader in interface IInAppMessageImmersive

Returns:

the header text on this in-app message.

getHeaderTextColor

public int getHeaderTextColor()

Description copied from interface: IInAppMessageImmersive

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

Specified by:

getHeaderTextColor in interface IInAppMessageImmersive

Returns:

See Color

getCloseButtonColor

public int getCloseButtonColor()

Description copied from interface: IInAppMessageImmersive

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

Specified by:

getCloseButtonColor in interface IInAppMessageImmersive

Returns:

See Color

getMessageButtons

public java.util.List<MessageButton> getMessageButtons()

Description copied from interface: IInAppMessageImmersive

Gets the message buttons for this in-app message.

See MessageButton.

Specified by:

getMessageButtons in interface IInAppMessageImmersive

Returns:

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

getFrameColor

public java.lang.Integer getFrameColor()

Description copied from interface: IInAppMessageImmersive

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

Specified by:

getFrameColor in interface IInAppMessageImmersive

Returns:

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

getImageStyle

public ImageStyle getImageStyle()

Description copied from interface: IInAppMessageImmersive

Get the image style on this in-app message.

Specified by:

getImageStyle in interface IInAppMessageImmersive

Returns:

the image style for this in-app message

getHeaderTextAlign

public TextAlign getHeaderTextAlign()

Description copied from interface: IInAppMessageImmersive

Get the text alignment for the header text.

Specified by:

getHeaderTextAlign in interface IInAppMessageImmersive

Returns:

the text alignment for the header text

setHeaderTextAlign

public void setHeaderTextAlign(TextAlign textAlign)

Description copied from interface: IInAppMessageImmersive

Set the text alignment for the header text.

Specified by:

setHeaderTextAlign in interface IInAppMessageImmersive

Parameters:

textAlign - the text alignment for the header text

setImageStyle

public void setImageStyle(ImageStyle imageStyle)

Description copied from interface: IInAppMessageImmersive

Set the image style on this in-app message.

Specified by:

setImageStyle in interface IInAppMessageImmersive

Parameters:

imageStyle - the image style for this in-app message

setFrameColor

public void setFrameColor(java.lang.Integer frameColor)

Description copied from interface: IInAppMessageImmersive

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

Specified by:

setFrameColor in interface IInAppMessageImmersive

Parameters:

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

setMessageButtons

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

Description copied from interface: IInAppMessageImmersive

Sets the message buttons for this in-app message.

See MessageButton

Specified by:

setMessageButtons in interface IInAppMessageImmersive

Parameters:

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

setHeader

public void setHeader(java.lang.String header)

Description copied from interface: IInAppMessageImmersive

Sets the header text of this in-app message.

Specified by:

setHeader in interface IInAppMessageImmersive

Parameters:

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

setHeaderTextColor

public void setHeaderTextColor(int headerTextColor)

Description copied from interface: IInAppMessageImmersive

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

Specified by:

setHeaderTextColor in interface IInAppMessageImmersive

Parameters:

headerTextColor - See Color

setCloseButtonColor

public void setCloseButtonColor(int closeButtonColor)

Description copied from interface: IInAppMessageImmersive

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

Specified by:

setCloseButtonColor in interface IInAppMessageImmersive

Parameters:

closeButtonColor - See Color

logButtonClick

public boolean logButtonClick(MessageButton messageButton)

Description copied from interface: IInAppMessageImmersive

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

Specified by:

logButtonClick in interface IInAppMessageImmersive

Returns:

true iff the click was successfully logged.

onAfterClosed

public void onAfterClosed()

Description copied from interface: IInAppMessage

Should be called on the in-app message once it is no longer being displayed, to allow it to perform any cleanup or trigger further actions.

Specified by:

onAfterClosed in interface IInAppMessage

Overrides:

onAfterClosed in class InAppMessageBase

enableDarkTheme

public void enableDarkTheme()

Description copied from interface: IInAppMessageThemeable

Instructs the IInAppMessage to apply any dark theme settings and override any existing values present on the IInAppMessage.

Specified by:

enableDarkTheme in interface IInAppMessageThemeable

Overrides:

enableDarkTheme in class InAppMessageBase

forJsonPut

public org.json.JSONObject forJsonPut()

Description copied from class: InAppMessageBase

Storing in-app messages serialized with this method is primarily for storage as triggered actions. This allows in-app messages to be stored to disk and retrieved later for display when an in-app message triggered action is triggered.

Specified by:

forJsonPut in interface IPutIntoJson<org.json.JSONObject>

Overrides:

forJsonPut in class InAppMessageWithImageBase

Returns:

a JSON representation of this in-app message sufficient for restoring it as a triggered action.