com.braze.models.inappmessage

Class InAppMessageHtmlBase

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

com.braze.models.inappmessage.InAppMessageHtmlBase

All Implemented Interfaces:

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

Direct Known Subclasses:

InAppMessageHtml, InAppMessageZippedAssetHtmlBase

public abstract class InAppMessageHtmlBase
extends InAppMessageBase
implements IInAppMessageHtml

Field Summary

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	InAppMessageHtmlBase()
	InAppMessageHtmlBase(org.json.JSONObject object, IBrazeManager appboyManager)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getLocalAssetsDirectoryUrl() Gets the local URL of the assets.
boolean	logButtonClick(java.lang.String buttonId) Logs a click on a button in your html 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	setLocalAssetsDirectoryUrl(java.lang.String assetsLocalDirectoryUrl) Sets the local URL of the assets directory for the html 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.

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

enableDarkTheme, forJsonPut, getAnimateIn, getAnimateOut, getBackgroundColor, getClickAction, getCropType, getDismissType, getDurationInMilliseconds, getExpirationTimestamp, getExtras, getIcon, getIconBackgroundColor, getIconColor, getLocalPrefetchedAssetPaths, getMessage, getMessageTextAlign, getMessageTextColor, getOpenUriInWebView, getOrientation, getRemoteAssetPathsForPrefetch, 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, setMessage, setMessageTextAlign, setMessageTextColor, setOpenUriInWebView, setOrientation

Methods inherited from interface com.braze.models.IPutIntoJson

forJsonPut

Constructor Detail

InAppMessageHtmlBase

protected InAppMessageHtmlBase()

InAppMessageHtmlBase

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

Throws:

org.json.JSONException

Method Detail

getLocalAssetsDirectoryUrl

public java.lang.String getLocalAssetsDirectoryUrl()

Description copied from interface: IInAppMessageHtml

Gets the local URL of the assets. This location corresponds to the unzipped file system directory of the remote assets file given by getAssetsZipRemoteUrl().

Specified by:

getLocalAssetsDirectoryUrl in interface IInAppMessageHtml

Returns:

Local file URL for the unpacked assets directory.

setLocalAssetsDirectoryUrl

public void setLocalAssetsDirectoryUrl(java.lang.String assetsLocalDirectoryUrl)

Description copied from interface: IInAppMessageHtml

Sets the local URL of the assets directory for the html In-App Message.

Specified by:

setLocalAssetsDirectoryUrl in interface IInAppMessageHtml

Parameters:

assetsLocalDirectoryUrl - Local file URL for the unpacked assets directory.

setLocalPrefetchedAssetPaths

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

Description copied from class: InAppMessageBase

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

Specified by:

setLocalPrefetchedAssetPaths in interface IInAppMessage

Overrides:

setLocalPrefetchedAssetPaths in class InAppMessageBase

Parameters:

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

logButtonClick

public boolean logButtonClick(java.lang.String buttonId)

Description copied from interface: IInAppMessageHtml

Logs a click on a button in your html in-app message.

Button clicks may only be logged once per in-app message.

Specified by:

logButtonClick in interface IInAppMessageHtml

Parameters:

buttonId - the id of the button

Returns:

true if 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