com.braze.models.inappmessage

Class InAppMessageBase

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

All Implemented Interfaces:

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

Direct Known Subclasses:

InAppMessageControl, InAppMessageHtmlBase, InAppMessageWithImageBase

public abstract class InAppMessageBase
extends java.lang.Object
implements IInAppMessage, IInAppMessageThemeable

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	ANIMATE_IN
protected static java.lang.String	ANIMATE_OUT
protected static java.lang.String	CROP_TYPE
static int	INAPP_MESSAGE_DURATION_DEFAULT_MILLIS
static int	INAPP_MESSAGE_DURATION_MIN_MILLIS
static java.lang.String	IS_CONTROL
protected IBrazeManager	mBrazeManager
protected CropType	mCropType
protected static java.lang.String	MESSAGE_TEXT_ALIGN
protected InAppMessageTheme	mInAppMessageDarkThemeWrapper
protected org.json.JSONObject	mJsonObject
protected TextAlign	mMessageTextAlign
protected boolean	mOpenUriInWebview
protected static java.lang.String	OPEN_URI_IN_WEBVIEW
static java.lang.String	TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InAppMessageBase()
	InAppMessageBase(org.json.JSONObject object, IBrazeManager brazeManager)

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.
boolean	getAnimateIn() Gets whether this in-app message will animate in or appear suddenly.
boolean	getAnimateOut() Gets whether this in-app message will animate out or disappear suddenly.
int	getBackgroundColor() Gets the background color on this in-app message.
ClickAction	getClickAction() Gets the click action of this in-app message.
CropType	getCropType() Gets the crop type for this in-app message's image.
DismissType	getDismissType() Gets the dismiss type of this in-app message.
int	getDurationInMilliseconds() Gets the duration of this in-app message.
long	getExpirationTimestamp() Get the UTC timestamp at which this message expires and will not be displayed.
java.util.Map<java.lang.String,java.lang.String>	getExtras() Gets the extras on this in-app message as a map of key value pairs.
java.lang.String	getIcon() Gets the Font Awesome icon on this in-app message.
int	getIconBackgroundColor() Gets the icon background color on this in-app message.
int	getIconColor() Gets the icon color on this in-app message.
java.util.Map<java.lang.String,java.lang.String>	getLocalPrefetchedAssetPaths() Note that this class does not have an implementation for this method.
java.lang.String	getMessage() Gets the message text on this in-app message.
TextAlign	getMessageTextAlign() Get the text alignment for the message text.
int	getMessageTextColor() Gets the message text color on this in-app message.
boolean	getOpenUriInWebView() Whether to use AppboyWebViewActivity to open deep links from this in-app message.
Orientation	getOrientation() Gets the preferred screen orientation for this in-app message.
java.util.List<java.lang.String>	getRemoteAssetPathsForPrefetch() Returns a path to remote assets that can be pre-fetched.
android.net.Uri	getUri() Gets the URI on this in-app message.
boolean	isControl() Gets whether this in-app message is a control for multivariate testing.
boolean	logClick() Logs a click on this in-app message.
boolean	logDisplayFailure(InAppMessageFailureType failureType) Logs a display failure on this in-app message.
boolean	logImpression() Logs an impression on this in-app message.
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	setAnimateIn(boolean animateIn) Sets whether this in-app message will animate in or appear suddenly.
void	setAnimateOut(boolean animateOut) Sets whether this in-app message will animate out or disappear suddenly.
void	setBackgroundColor(int backgroundColor) Sets the background color on this in-app message.
boolean	setClickAction(ClickAction clickAction) Sets the click action of this in-app message.
boolean	setClickAction(ClickAction clickAction, android.net.Uri uri) Sets the click action of this in-app message.
void	setCropType(CropType cropType) Sets the crop type for this in-app message's image.
void	setDismissType(DismissType dismissType) Sets the dismiss type of this in-app message.
void	setDurationInMilliseconds(int durationInMilliseconds) Sets the duration of this in-app message.
void	setExpirationTimestamp(long timestamp) Set the UTC timestamp at which this message expires and will not be displayed.
void	setExtras(java.util.Map<java.lang.String,java.lang.String> extras) Sets or overrides the extras on this in-app message as a map of key value pairs.
void	setIcon(java.lang.String icon) Sets the icon on this in-app message.
void	setIconBackgroundColor(int iconBackgroundColor) Sets the icon background color on this in-app message.
void	setIconColor(int iconColor) Sets the icon color on this in-app message.
void	setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap) The base In-App Message class does not have assets of its own.
void	setMessage(java.lang.String message) Sets the message text of this in-app message.
void	setMessageTextAlign(TextAlign textAlign) Set the text alignment for the message text.
void	setMessageTextColor(int textColor) Sets the message text color on this in-app message.
void	setOpenUriInWebView(boolean openUriInWebView) Sets whether to use AppboyWebViewActivity to open deep links from this in-app message.
void	setOrientation(Orientation orientation) Sets the preferred screen orientation for this in-app message.

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

getMessageType

Field Detail

INAPP_MESSAGE_DURATION_DEFAULT_MILLIS

public static final int INAPP_MESSAGE_DURATION_DEFAULT_MILLIS

See Also:

Constant Field Values

INAPP_MESSAGE_DURATION_MIN_MILLIS

public static final int INAPP_MESSAGE_DURATION_MIN_MILLIS

See Also:

Constant Field Values

CROP_TYPE

protected static final java.lang.String CROP_TYPE

See Also:

Constant Field Values

MESSAGE_TEXT_ALIGN

protected static final java.lang.String MESSAGE_TEXT_ALIGN

See Also:

Constant Field Values

ANIMATE_IN

protected static final java.lang.String ANIMATE_IN

See Also:

Constant Field Values

ANIMATE_OUT

protected static final java.lang.String ANIMATE_OUT

See Also:

Constant Field Values

OPEN_URI_IN_WEBVIEW

protected static final java.lang.String OPEN_URI_IN_WEBVIEW

See Also:

Constant Field Values

IS_CONTROL

public static final java.lang.String IS_CONTROL

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

mCropType

protected CropType mCropType

mMessageTextAlign

protected TextAlign mMessageTextAlign

mOpenUriInWebview

protected boolean mOpenUriInWebview

mJsonObject

protected org.json.JSONObject mJsonObject

mBrazeManager

protected IBrazeManager mBrazeManager

mInAppMessageDarkThemeWrapper

protected InAppMessageTheme mInAppMessageDarkThemeWrapper

Constructor Detail

InAppMessageBase

protected InAppMessageBase()

InAppMessageBase

public InAppMessageBase(org.json.JSONObject object,
                        IBrazeManager brazeManager)
                 throws org.json.JSONException

Throws:

org.json.JSONException - if JSON is malformed. Constructed InAppMessageBase objects are meant to be fully verified and good to go.

Method Detail

getMessage

public java.lang.String getMessage()

Description copied from interface: IInAppMessage

Gets the message text on this in-app message.

Specified by:

getMessage in interface IInAppMessage

Returns:

the message text on this in-app message.

getExtras

public java.util.Map<java.lang.String,java.lang.String> getExtras()

Description copied from interface: IInAppMessage

Gets the extras on this in-app message as a map of key value pairs.

Specified by:

getExtras in interface IInAppMessage

Returns:

a map of extras on this in-app message.

setExtras

public void setExtras(java.util.Map<java.lang.String,java.lang.String> extras)

Description copied from interface: IInAppMessage

Sets or overrides the extras on this in-app message as a map of key value pairs.

Specified by:

setExtras in interface IInAppMessage

Parameters:

extras - A map of extras on this in-app message.

getDurationInMilliseconds

public int getDurationInMilliseconds()

Description copied from interface: IInAppMessage

Gets the duration of this in-app message.

Specified by:

getDurationInMilliseconds in interface IInAppMessage

Returns:

the duration of this in-app message.

getBackgroundColor

public int getBackgroundColor()

Description copied from interface: IInAppMessage

Gets the background color on this in-app message.

Specified by:

getBackgroundColor in interface IInAppMessage

Returns:

See Color

getIconColor

public int getIconColor()

Description copied from interface: IInAppMessage

Gets the icon color on this in-app message.

See IInAppMessage.getIconColor()

Specified by:

getIconColor in interface IInAppMessage

Returns:

See Color

getIconBackgroundColor

public int getIconBackgroundColor()

Description copied from interface: IInAppMessage

Gets the icon background color on this in-app message.

See IInAppMessage.setIconBackgroundColor(int)

Specified by:

getIconBackgroundColor in interface IInAppMessage

Returns:

See Color

getMessageTextColor

public int getMessageTextColor()

Description copied from interface: IInAppMessage

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

Specified by:

getMessageTextColor in interface IInAppMessage

Returns:

See Color

getIcon

public java.lang.String getIcon()

Description copied from interface: IInAppMessage

Gets the Font Awesome icon on this in-app message.

Specified by:

getIcon in interface IInAppMessage

Returns:

Unicode string for the Font Awesome icon.

getAnimateIn

public boolean getAnimateIn()

Description copied from interface: IInAppMessage

Gets whether this in-app message will animate in or appear suddenly.

Specified by:

getAnimateIn in interface IInAppMessage

Returns:

whether the in-app message will animate in.

getAnimateOut

public boolean getAnimateOut()

Description copied from interface: IInAppMessage

Gets whether this in-app message will animate out or disappear suddenly.

Specified by:

getAnimateOut in interface IInAppMessage

Returns:

whether the in-app message will animate out.

getClickAction

public ClickAction getClickAction()

Description copied from interface: IInAppMessage

Gets the click action of this in-app message.

See ClickAction

Specified by:

getClickAction in interface IInAppMessage

Returns:

the click action on this in-app message.

getUri

public android.net.Uri getUri()

Description copied from interface: IInAppMessage

Gets the URI on this in-app message.

See IInAppMessage.setClickAction(ClickAction, android.net.Uri)

Specified by:

getUri in interface IInAppMessage

Returns:

the URI on this in-app message, or null if not set.

getDismissType

public DismissType getDismissType()

Description copied from interface: IInAppMessage

Gets the dismiss type of this in-app message.

See DismissType

Specified by:

getDismissType in interface IInAppMessage

Returns:

the dismiss type of this in-app message.

getOrientation

public Orientation getOrientation()

Description copied from interface: IInAppMessage

Gets the preferred screen orientation for this in-app message.

In-app messages will only display if the preferred orientation matches the current activity orientation. However, there is an important exception for tablets For in-app messages that have a preferred orientation and are being displayed on tablet, the in-app message will appear in the style of the preferred orientation regardless of actual screen orientation.

Specified by:

getOrientation in interface IInAppMessage

Returns:

the preferred screen orientation for this in-app message

getCropType

public CropType getCropType()

Description copied from interface: IInAppMessage

Gets the crop type for this in-app message's image.

Specified by:

getCropType in interface IInAppMessage

Returns:

the image crop type for this in-app message's image.

getMessageTextAlign

public TextAlign getMessageTextAlign()

Description copied from interface: IInAppMessage

Get the text alignment for the message text.

Specified by:

getMessageTextAlign in interface IInAppMessage

Returns:

the text alignment for the message text

getExpirationTimestamp

public long getExpirationTimestamp()

Description copied from interface: IInAppMessage

Get the UTC timestamp at which this message expires and will not be displayed.

Specified by:

getExpirationTimestamp in interface IInAppMessage

Returns:

the expiration timestamp for the message

getOpenUriInWebView

public boolean getOpenUriInWebView()

Description copied from interface: IInAppMessage

Whether to use AppboyWebViewActivity to open deep links from this in-app message.

When true, the SDK will make a best effort to use AppboyWebViewActivity to open the deep link.

When false, deep links are opened using an Intent.ACTION_VIEW intent.

See IInAppMessage.setOpenUriInWebView(boolean)

Specified by:

getOpenUriInWebView in interface IInAppMessage

Returns:

true if AppboyWebViewActivity should be used to open deep links from this in-app message.

setOpenUriInWebView

public void setOpenUriInWebView(boolean openUriInWebView)

Description copied from interface: IInAppMessage

Sets whether to use AppboyWebViewActivity to open deep links from this in-app message.

See IInAppMessage.getOpenUriInWebView()

Specified by:

setOpenUriInWebView in interface IInAppMessage

Parameters:

openUriInWebView - whether AppboyWebViewActivity should be used to open deep links from this in-app message.

setExpirationTimestamp

public void setExpirationTimestamp(long timestamp)

Description copied from interface: IInAppMessage

Set the UTC timestamp at which this message expires and will not be displayed.

Specified by:

setExpirationTimestamp in interface IInAppMessage

Parameters:

timestamp - expiration timestamp for the message

setMessageTextAlign

public void setMessageTextAlign(TextAlign textAlign)

Description copied from interface: IInAppMessage

Set the text alignment for the message text.

Specified by:

setMessageTextAlign in interface IInAppMessage

Parameters:

textAlign - the text alignment for the message text

setCropType

public void setCropType(CropType cropType)

Description copied from interface: IInAppMessage

Sets the crop type for this in-app message's image.

Specified by:

setCropType in interface IInAppMessage

Parameters:

cropType - the image crop type for this in-app message's image.

setOrientation

public void setOrientation(Orientation orientation)

Description copied from interface: IInAppMessage

Sets the preferred screen orientation for this in-app message.

In-app messages will only display if the preferred orientation matches the current activity orientation. However, there is an important exception for tablets For in-app messages that have a preferred orientation and are being displayed on tablet, the in-app message will appear in the style of the preferred orientation regardless of actual screen orientation.

Specified by:

setOrientation in interface IInAppMessage

Parameters:

orientation - the preferred screen orientation for this in-app message

setMessage

public void setMessage(java.lang.String message)

Description copied from interface: IInAppMessage

Sets the message text of this in-app message.

Specified by:

setMessage in interface IInAppMessage

Parameters:

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

setAnimateIn

public void setAnimateIn(boolean animateIn)

Description copied from interface: IInAppMessage

Sets whether this in-app message will animate in or appear suddenly. The recommended default is true.

Specified by:

setAnimateIn in interface IInAppMessage

Parameters:

animateIn - whether to animate the in-app message in.

setAnimateOut

public void setAnimateOut(boolean animateOut)

Description copied from interface: IInAppMessage

Sets whether this in-app message will animate out or disappear suddenly. The recommended default is true.

Specified by:

setAnimateOut in interface IInAppMessage

Parameters:

animateOut - whether to animate the in-app message out.

setClickAction

public boolean setClickAction(ClickAction clickAction)

Description copied from interface: IInAppMessage

Sets the click action of this in-app message.

See ClickAction

Specified by:

setClickAction in interface IInAppMessage

Parameters:

clickAction - The desired click action.

Returns:

true if the click action was successfully set.

setClickAction

public boolean setClickAction(ClickAction clickAction,
                              android.net.Uri uri)

Description copied from interface: IInAppMessage

Sets the click action of this in-app message.

See ClickAction

Specified by:

setClickAction in interface IInAppMessage

Parameters:

clickAction - The desired click action.

uri - A valid Uri to navigate to on click. To set the Uri, the click action must be set to URI and a non-null Uri must be specified.

Returns:

true if the click action was successfully set.

setDismissType

public void setDismissType(DismissType dismissType)

Description copied from interface: IInAppMessage

Sets the dismiss type of this in-app message.

See DismissType

Specified by:

setDismissType in interface IInAppMessage

Parameters:

dismissType - Desired dismiss type.

setDurationInMilliseconds

public void setDurationInMilliseconds(int durationInMilliseconds)

Description copied from interface: IInAppMessage

Sets the duration of this in-app message.

Specified by:

setDurationInMilliseconds in interface IInAppMessage

Parameters:

durationInMilliseconds - Desired in-app message duration. Inappropriately low or high values should be set to a reasonable default.

setBackgroundColor

public void setBackgroundColor(int backgroundColor)

Description copied from interface: IInAppMessage

Sets the background color on this in-app message.

Specified by:

setBackgroundColor in interface IInAppMessage

Parameters:

backgroundColor - See Color

setIconColor

public void setIconColor(int iconColor)

Description copied from interface: IInAppMessage

Sets the icon color on this in-app message. This will set the color of the icon itself (not the background).

See IInAppMessage.setIconBackgroundColor(int)

Specified by:

setIconColor in interface IInAppMessage

Parameters:

iconColor - See Color

setIconBackgroundColor

public void setIconBackgroundColor(int iconBackgroundColor)

Description copied from interface: IInAppMessage

Sets the icon background color on this in-app message. This will set the color of the icon background itself (not the icon itself).

See IInAppMessage.setIconColor(int)

Specified by:

setIconBackgroundColor in interface IInAppMessage

Parameters:

iconBackgroundColor - See Color

setMessageTextColor

public void setMessageTextColor(int textColor)

Description copied from interface: IInAppMessage

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

Specified by:

setMessageTextColor in interface IInAppMessage

Parameters:

textColor - See Color

setIcon

public void setIcon(java.lang.String icon)

Description copied from interface: IInAppMessage

Sets the icon on this in-app message.

Specified by:

setIcon in interface IInAppMessage

Parameters:

icon - Unicode string for the desired Font Awesome icon.

getLocalPrefetchedAssetPaths

public java.util.Map<java.lang.String,java.lang.String> getLocalPrefetchedAssetPaths()

Note that this class does not have an implementation for this method.

Specified by:

getLocalPrefetchedAssetPaths in interface IInAppMessage

Returns:

An empty map.

logImpression

public boolean logImpression()

Description copied from interface: IInAppMessage

Logs an impression on this in-app message. Impressions may only be logged once per in-app message instance.

See IInAppMessage.logClick()

Specified by:

logImpression in interface IInAppMessage

Returns:

true iff the impression was successfully logged.

logClick

public boolean logClick()

Description copied from interface: IInAppMessage

Logs a click on this in-app message. Clicks may only be logged once per in-app message instance.

See IInAppMessage.logImpression()

Specified by:

logClick in interface IInAppMessage

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

isControl

public boolean isControl()

Description copied from interface: IInAppMessage

Gets whether this in-app message is a control for multivariate testing. Control in-app messages should not be displayed to users.

Specified by:

isControl in interface IInAppMessage

Returns:

whether this in-app message is a control.

logDisplayFailure

public boolean logDisplayFailure(InAppMessageFailureType failureType)

Description copied from interface: IInAppMessage

Logs a display failure on this in-app message. Failures can only be logged once per in-app message instance and should be logged as early as possible in the display process.

In-app message display failures may affect campaign statistics so care should be taken when logging display failures.

Specified by:

logDisplayFailure in interface IInAppMessage

Parameters:

failureType - The precise type of the display failure.

Returns:

true if the display failure was successfully logged.

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

getRemoteAssetPathsForPrefetch

public java.util.List<java.lang.String> getRemoteAssetPathsForPrefetch()

Description copied from interface: IInAppMessage

Returns a path to remote assets that can be pre-fetched. To point this in-app message to pre-fetched assets, use IInAppMessage.setLocalPrefetchedAssetPaths(Map)

Specified by:

getRemoteAssetPathsForPrefetch in interface IInAppMessage

Returns:

An empty list. The base In-App Message class does not have assets of its own. Subclasses provide and manage assets.

setLocalPrefetchedAssetPaths

public void setLocalPrefetchedAssetPaths(java.util.Map<java.lang.String,java.lang.String> remotePathToLocalAssetMap)

The base In-App Message class does not have assets of its own. Subclasses provide and manage assets.

Specified by:

setLocalPrefetchedAssetPaths in interface IInAppMessage

Parameters:

remotePathToLocalAssetMap - A map of remote assets Uris to local asset Uri paths.

forJsonPut

public org.json.JSONObject forJsonPut()

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>

Returns:

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