InAppMessageWithImageBase

abstract class InAppMessageWithImageBase : InAppMessageBase, IInAppMessageWithImage

Constructors

protected fun InAppMessageWithImageBase()

InAppMessageWithImageBase

fun InAppMessageWithImageBase(jsonObject: JSONObject, brazeManager: IBrazeManager)

Types

Companion

object Companion

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.

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>

logClick

open override fun logClick(): Boolean

Logs a click on this in-app message.

logDisplayFailure

open override fun logDisplayFailure(failureType: InAppMessageFailureType): Boolean

Logs a display failure on this in-app message.

logImpression

open override fun logImpression(): Boolean

Logs an impression on this in-app message.

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

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.

Properties

animateIn

open override var animateIn: Boolean = true

Whether this in-app message will animate in or appear suddenly.

animateOut

open override var animateOut: Boolean = true

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

backgroundColor

@ColorInt()

open override var backgroundColor: Int

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

bitmap

open override var bitmap: Bitmap? = null

The bitmap on this in-app message.

brazeManager

var brazeManager: IBrazeManager? = null

clickAction

open override val clickAction: ClickAction

The click action of this in-app message.

clickLogged

private val clickLogged: AtomicBoolean

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.

displayFailureLogged

private val displayFailureLogged: AtomicBoolean

durationInMilliseconds

open override var durationInMilliseconds: Int

Gets the duration of this in-app message.

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

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.

iconColor

@ColorInt()

open override var iconColor: Int

The icon color (android.graphics.Color) of this in-app message.

imageDownloadSuccessful

open override var imageDownloadSuccessful: Boolean = false

The status of the image download on this in-app message.

imageUrl

open override val imageUrl: String?

Gets the image url on this in-app message.

impressionLogged

private val impressionLogged: AtomicBoolean

inAppMessageDarkThemeWrapper

var inAppMessageDarkThemeWrapper: InAppMessageTheme? = null

internalClickAction

private var internalClickAction: ClickAction

A backing variable for the clickAction property to make it read-only.

internalUri

private var internalUri: Uri? = null

A backing variable for the uri property to make it read-only.

isControl

open override val isControl: Boolean

Whether this in-app message is a control for multivariate testing.

jsonObject

var jsonObject: JSONObject? = null

localImageUrl

open override var localImageUrl: String? = null

The local uri of this in-app message image.

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

@ColorInt()

open override var messageTextColor: Int

The message text color on this in-app message.

messageType

abstract 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.

remoteImageUrl

open override var remoteImageUrl: String? = null

The remote uri of this in-app message image.

triggerId

val triggerId: String?

uri

open override val uri: Uri?

The URI on this in-app message.

Inheritors

InAppMessageSlideup

InAppMessageImmersiveBase