IInAppMessageZippedAssetHtml

This is the base model interface for all Html In-App Messages with ZIP file backed assets.

The expected format is an html string accompanied with a zip file remote url containing all the assets such as images, fonts, etc. The html string is encoded into the message field of the IInAppMessage.

Functions

Link copied to clipboard
abstract fun forJsonPut(): JSONObject
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract fun logButtonClick(buttonId: String): Boolean

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

Link copied to clipboard
abstract fun logClick(): Boolean

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

Link copied to clipboard

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.

Link copied to clipboard
abstract fun logImpression(): Boolean

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

Link copied to clipboard
abstract 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.

Link copied to clipboard
abstract fun setClickBehavior(clickAction: ClickAction)

Convenience method that calls setClickBehavior(clickAction, null).

abstract fun setClickBehavior(clickAction: ClickAction, uri: Uri? = null)

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

Link copied to clipboard
abstract fun setLocalPrefetchedAssetPaths(remotePathToLocalAssetMap: Map<String, String>)

Instruct this in-app message where to find pre-fetched assets for remote assets specified in .getRemoteAssetPathsForPrefetch.

Properties

Link copied to clipboard
abstract var animateIn: Boolean

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

Link copied to clipboard
abstract var animateOut: Boolean

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

Link copied to clipboard
abstract var assetsZipRemoteUrl: String?

The remote URL of the assets zip file of this In-App Message.

Link copied to clipboard
abstract var backgroundColor: Int

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

Link copied to clipboard
abstract val clickAction: ClickAction

The click action of this in-app message.

Link copied to clipboard
abstract var cropType: CropType

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

Link copied to clipboard
abstract var dismissType: DismissType

The dismiss type of this in-app message.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract var extras: Map<String, String>

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

Link copied to clipboard
abstract var icon: String?

The Font Awesome icon on this in-app message.

Link copied to clipboard
abstract 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).

Link copied to clipboard
abstract 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).

Link copied to clipboard
abstract val isControl: Boolean

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

Link copied to clipboard

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

Link copied to clipboard
abstract var message: String?

The message text on this in-app message.

Link copied to clipboard

The text alignment for the message text.

Link copied to clipboard
abstract var messageTextColor: Int

The message text color on this in-app message.

Link copied to clipboard
abstract val messageType: MessageType

The MessageType of this in-app message.

Link copied to clipboard

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

Link copied to clipboard
abstract var orientation: Orientation

The preferred screen orientation for this in-app message.

Link copied to clipboard
abstract val uri: Uri?

The URI on this in-app message.

Inheritors

Link copied to clipboard