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

IInAppMessageImmersive

interface IInAppMessageImmersive : IInAppMessage

InAppMessageBase is the base model interface for all immersive in-app messages.

An immersive in-app message is defined as an in-app message that takes up the entire screen and/or 'blocks' the user from interacting with the app until the message is dismissed. Immersive messages extend the base in-app message with header text, message buttons, and a close button.

Functions

Link copied to clipboard
abstract fun forJsonPut(): JSONObject
Link copied to clipboard
open fun getLocalPrefetchedAssetPaths(): Map<String, String>

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

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

Link copied to clipboard
abstract fun logButtonClick(messageButton: MessageButton): Boolean

Logs a click on this message button.

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

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

The close button color on 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
abstract var durationInMilliseconds: Int

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

Link copied to clipboard
abstract var expirationTimestamp: Long

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

The frame color for this in-app message. The frame refers to the area surrounding a modal in-app message.

Link copied to clipboard
abstract var header: String?

The header text on this in-app message.

Link copied to clipboard
abstract var headerTextAlign: TextAlign

The text alignment for the header text.

Link copied to clipboard
abstract var headerTextColor: Int

The header text color on this in-app message.

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 var imageStyle: ImageStyle

The image style on this in-app message.

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
abstract var message: String?

The message text on this in-app message.

Link copied to clipboard
abstract var messageButtons: List<MessageButton>

The message buttons for this in-app message.

Link copied to clipboard
abstract var messageTextAlign: TextAlign

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
abstract var openUriInWebView: Boolean

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