android-sdk-base/com.braze.models.inappmessage/InAppMessageHtmlFull

InAppMessageHtmlFull

class InAppMessageHtmlFull : InAppMessageZippedAssetHtmlBase

Constructors

fun InAppMessageHtmlFull()

InAppMessageHtmlFull

fun InAppMessageHtmlFull(jsonObject: <Error class: unknown class>, brazeManager: <Error class: unknown class>)

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(): <Error class: unknown class>

getLocalPrefetchedAssetPaths

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

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

getRemoteAssetPathsForPrefetch

open override fun getRemoteAssetPathsForPrefetch(): List<String>

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

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 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: <Error class: unknown class>?)

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.

Properties

animateIn

open override var animateIn: Boolean = true

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

animateOut

open override var animateOut: Boolean = true

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

assetsZipRemoteUrl

open override var assetsZipRemoteUrl: String? = null

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

backgroundColor

open override var backgroundColor: <Error class: unknown class>

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

brazeManager

var brazeManager: <Error class: unknown class>? = null

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: <Error class: unknown class>

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

icon

open override var icon: String? = null

The Font Awesome icon on this in-app message.

iconBackgroundColor

open override var iconBackgroundColor: <Error class: unknown class>

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

iconColor

open override var iconColor: <Error class: unknown class>

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: <Error class: unknown class>? = null

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.

isTestSend

open override var isTestSend: Boolean = false

Is this in-app message from a test send.

jsonObject

var jsonObject: <Error class: unknown class>? = null

localAssetsDirectoryUrl

open override var localAssetsDirectoryUrl: String? = null

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? = null

The message text on this in-app message.

messageTextAlign

open override var messageTextAlign: TextAlign

The text alignment for the message text.

messageTextColor

open override var messageTextColor: <Error class: unknown class>

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 = false

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: <Error class: unknown class>?

The URI on this in-app message.