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

InAppMessageControl

open class InAppMessageControl(jsonObject: JSONObject, brazeManager: IBrazeManager) : InAppMessageBase

If the user is enrolled in the control group of an in-app message campaign, an InAppMessageControl should be instantiated. InAppMessageControl instances can be serialized and used for analytics only. They should never be used to back an actual in-app message for display.

Constructors

InAppMessageControl

fun InAppMessageControl(jsonObject: JSONObject, brazeManager: IBrazeManager)

Functions

enableDarkTheme

open override fun enableDarkTheme()

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

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 fun getLocalPrefetchedAssetPaths(): Map<String, String>

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

getRemoteAssetPathsForPrefetch

open override fun getRemoteAssetPathsForPrefetch(): List<String>

open override fun logClick(): Boolean

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

logDisplayFailure

open override fun logDisplayFailure(failureType: InAppMessageFailureType): Boolean

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.

open override fun logImpression(): Boolean

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

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.

Properties

open override var animateIn: Boolean = true

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

open override var animateOut: Boolean = true

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

backgroundColor

open override var backgroundColor: Int

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

var brazeManager: IBrazeManager? = null

open override val clickAction: ClickAction

The click action of this in-app message.

open override var cropType: CropType

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

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.

open override var extras: Map<String, String>

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

open override var icon: String? = null

The Font Awesome icon on this in-app message.

iconBackgroundColor

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

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

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.

var jsonObject: JSONObject? = null

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: Int

The message text color on this in-app message.

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.

open override var orientation: Orientation

The preferred screen orientation for this in-app message.

val triggerId: String?

open override val uri: Uri?

The URI on this in-app message.