braze-android-sdk/com.braze.models.inappmessage/InAppMessageHtml

InAppMessageHtml

open class InAppMessageHtml : 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.

Constructors

InAppMessageHtml

constructor()

constructor(jsonObject: JSONObject, brazeManager: IBrazeManager)

Types

Companion

object Companion

Properties

animateIn

open override var animateIn: Boolean

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

animateOut

open override var animateOut: Boolean

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

assetUrls

var assetUrls: List<String>

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

backgroundColor

@ColorInt

open override var backgroundColor: Int

The android.graphics.Color background color on this in-app message.

brazeManager

var brazeManager: IBrazeManager?

clickAction

open override val clickAction: ClickAction

The click action of this in-app message.

cropType

open override var cropType: CropType

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

dismissType

open override var dismissType: DismissType

The dismiss type of this in-app message.

durationInMilliseconds

open override var durationInMilliseconds: Int

Gets the duration of this in-app message. Only valid for DismissType.AUTO_DISMISS.

expirationTimestamp

open override var expirationTimestamp: Long

Expiration timestamp is not stored locally since it changes dynamically depending on trigger time.

extras

open override var extras: Map<String, String>

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

icon

open override var icon: String?

The Font Awesome icon on this in-app message.

iconBackgroundColor

@ColorInt

open override var iconBackgroundColor: Int

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

iconColor

@ColorInt

open override var iconColor: Int

The icon color (android.graphics.Color) of this in-app message. This is the color of the icon itself (not the background).

inAppMessageDarkThemeWrapper

var inAppMessageDarkThemeWrapper: InAppMessageTheme?

isControl

open override val isControl: Boolean

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

isPushPrimer

val isPushPrimer: Boolean

isTestSend

open override var isTestSend: Boolean

Is this in-app message from a test send.

jsonObject

var jsonObject: JSONObject?

localAssetsDirectoryUrl

open override var localAssetsDirectoryUrl: String?

The local URL of the assets. This location corresponds to the unzipped file system directory of the remote assets file given by IInAppMessageZippedAssetHtml.assetsZipRemoteUrl.

message

open override var message: String?

The message text on this in-app message.

messageExtras

open override var messageExtras: String?

The message extras on this in-app message as a string. This field will be absent if there is no value.

messageFields

var messageFields: JSONObject?

The unstructured data accompanying this message.

messageTextAlign

open override var messageTextAlign: TextAlign

The text alignment for the message text.

messageTextColor

@ColorInt

open override var messageTextColor: Int

The message text color on this in-app message.

messageType

open override val messageType: MessageType

The MessageType of this in-app message.

openUriInWebView

open override var openUriInWebView: Boolean

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

orientation

open override var orientation: Orientation

The preferred screen orientation for this in-app message.

triggerId

val triggerId: String?

uri

open override val uri: Uri?

The URI on this in-app message.

Functions

enableDarkTheme

open override fun enableDarkTheme()

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

forJsonPut

open override fun forJsonPut(): JSONObject

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.

getLocalPrefetchedAssetPaths

open override fun getLocalPrefetchedAssetPaths(): Map<String, String>

Gets where to find the pre-fetched remote assets specified in setLocalPrefetchedAssetPaths.

getRemoteAssetPathsForPrefetch

open override fun getRemoteAssetPathsForPrefetch(): List<String>

logButtonClick

open override fun logButtonClick(buttonId: String): Boolean

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

logClick

open override fun logClick(): Boolean

Logs a click on this in-app message. Clicks (either with or without button IDs) may only be logged once per in-app message instance.

open override fun logClick(buttonId: String): Boolean

Logs a button click on this in-app message. Clicks (either with or without button IDs) may only be logged once per in-app message instance.

logImpression

open override fun logImpression(): Boolean

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

onAfterClosed

open override fun 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.

setClickBehavior

open override fun setClickBehavior(clickAction: ClickAction)

Convenience method that calls setClickBehavior(clickAction, null).

open override fun setClickBehavior(clickAction: ClickAction, uri: Uri?)

Sets the click action and/or Uri of this in-app message.

setLocalPrefetchedAssetPaths

open override fun setLocalPrefetchedAssetPaths(remotePathToLocalAssetMap: Map<String, String>)

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