com.braze.models.inappmessage

Class InAppMessageHtml

java.lang.Object

com.braze.models.inappmessage.InAppMessageBase

com.braze.models.inappmessage.InAppMessageHtmlBase

com.braze.models.inappmessage.InAppMessageHtml

All Implemented Interfaces:

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

public class InAppMessageHtml
extends InAppMessageHtmlBase

IInAppMessage that renders HTML without a corresponding zip file asset. Instead, assets are all self-contained within a single HTML file. Certain URLs within the HTML file may be specified for download; these URLS are referred to as the "asset URLs" of this in-app message type.

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

Constructor and Description
InAppMessageHtml()
InAppMessageHtml(org.json.JSONObject object, IBrazeManager appboyManager)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	forJsonPut() Storing in-app messages serialized with this method is primarily for storage as triggered actions.
java.util.List<java.lang.String>	getAssetUrls()
java.util.Map<java.lang.String,java.lang.String>	getLocalPrefetchedAssetPaths() Note that this class does not have an implementation for this method.
org.json.JSONObject	getMessageFields()
MessageType	getMessageType() The MessageType of this in-app message.
java.util.List<java.lang.String>	getRemoteAssetPathsForPrefetch() Returns a path to remote assets that can be pre-fetched.
void	setAssetUrls(java.util.List<java.lang.String> assetUrls) Sets the list of asset urls associated with this message for prefetch.
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	setMessageFields(org.json.JSONObject messageFields)

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

getLocalAssetsDirectoryUrl, logButtonClick, onAfterClosed, setLocalAssetsDirectoryUrl

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

enableDarkTheme, getAnimateIn, getAnimateOut, getBackgroundColor, getClickAction, getCropType, getDismissType, getDurationInMilliseconds, getExpirationTimestamp, getExtras, getIcon, getIconBackgroundColor, getIconColor, 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, 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

Constructor Detail

InAppMessageHtml

public InAppMessageHtml()

InAppMessageHtml

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

Throws:

org.json.JSONException

Method Detail

getMessageType

public MessageType getMessageType()

Description copied from interface: IInAppMessage

The MessageType of this in-app message.

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 InAppMessageHtmlBase

Parameters:

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

getLocalPrefetchedAssetPaths

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

Description copied from class: InAppMessageBase

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

Specified by:

getLocalPrefetchedAssetPaths in interface IInAppMessage

Overrides:

getLocalPrefetchedAssetPaths in class InAppMessageBase

Returns:

An empty map.

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

Overrides:

getRemoteAssetPathsForPrefetch in class InAppMessageBase

Returns:

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

setMessageFields

public void setMessageFields(org.json.JSONObject messageFields)

setAssetUrls

public void setAssetUrls(java.util.List<java.lang.String> assetUrls)

Sets the list of asset urls associated with this message for prefetch. The list here is returned by getRemoteAssetPathsForPrefetch()

getMessageFields

public org.json.JSONObject getMessageFields()

Returns:

The unstructured data accompanying this message.

getAssetUrls

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

Returns:

A list of the asset urls for preload. Will be an empty list if no assets provided.

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 InAppMessageBase

Returns:

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