com.braze.models.inappmessage

Interface IInAppMessageHtml

All Superinterfaces:

IInAppMessage, IPutIntoJson<org.json.JSONObject>

All Known Subinterfaces:

IInAppMessageZippedAssetHtml

All Known Implementing Classes:

InAppMessageHtml, InAppMessageHtmlBase, InAppMessageHtmlFull, InAppMessageZippedAssetHtmlBase

public interface IInAppMessageHtml
extends IInAppMessage

IInAppMessageHtml is the base model interface for all Html In-App Messages.

HTML In-App Messages are defined as In-App Messages that can take up the entire screen and/or 'block' the user from interacting with the app until the message is dismissed.

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	setLocalAssetsDirectoryUrl(java.lang.String assetsLocalDirectoryUrl) Sets the local URL of the assets directory for the html 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

setLocalAssetsDirectoryUrl

void setLocalAssetsDirectoryUrl(java.lang.String assetsLocalDirectoryUrl)

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

Parameters:

assetsLocalDirectoryUrl - Local file URL for the unpacked assets directory.

getLocalAssetsDirectoryUrl

java.lang.String getLocalAssetsDirectoryUrl()

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

Returns:

Local file URL for the unpacked assets directory.

logButtonClick

boolean logButtonClick(java.lang.String buttonId)

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

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

Parameters:

buttonId - the id of the button

Returns:

true if the click was successfully logged.