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

forJsonPut
Link copied to clipboard
abstract fun forJsonPut(): JSONObject
getLocalPrefetchedAssetPaths
Link copied to clipboard
open fun getLocalPrefetchedAssetPaths(): Map<String, String>
Gets where to find the pre-fetched remote assets specified in setLocalPrefetchedAssetPaths.
getRemoteAssetPathsForPrefetch
Link copied to clipboard
abstract fun getRemoteAssetPathsForPrefetch(): List<String>
Returns a path to remote assets that can be pre-fetched.
logButtonClick
Link copied to clipboard
abstract fun logButtonClick(messageButton: MessageButton): Boolean
Logs a click on this message button.
logClick
Link copied to clipboard
abstract fun logClick(): Boolean
Logs a click on this in-app message.
logDisplayFailure
Link copied to clipboard
abstract fun logDisplayFailure(failureType: InAppMessageFailureType): Boolean
Logs a display failure on this in-app message.
logImpression
Link copied to clipboard
abstract fun logImpression(): Boolean
Logs an impression on this in-app message.
onAfterClosed
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.
setClickBehavior
Link copied to clipboard
abstract fun setClickBehavior(clickAction: ClickAction)
Convenience method that calls
abstract fun setClickBehavior(clickAction: ClickAction, uri: Uri? = null)
Sets the click action and/or Uri of this in-app message.
setLocalPrefetchedAssetPaths
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 .

Properties

animateIn
Link copied to clipboard
abstract var animateIn: Boolean
Whether this in-app message will animate in or appear suddenly.
animateOut
Link copied to clipboard
abstract var animateOut: Boolean
Whether this in-app message will animate out or disappear suddenly.
backgroundColor
Link copied to clipboard
abstract var backgroundColor: Int
The android.graphics.Color background color on this in-app message.
clickAction
Link copied to clipboard
abstract val clickAction: ClickAction
The click action of this in-app message.
closeButtonColor
Link copied to clipboard
abstract var closeButtonColor: Int
The close button color on this in-app message.
cropType
Link copied to clipboard
abstract var cropType: CropType
The crop type for this in-app message's image.
dismissType
Link copied to clipboard
abstract var dismissType: DismissType
The dismiss type of this in-app message.
durationInMilliseconds
Link copied to clipboard
abstract var durationInMilliseconds: Int
Gets the duration of this in-app message.
expirationTimestamp
Link copied to clipboard
abstract var expirationTimestamp: Long
The UTC timestamp at which this message expires and will not be displayed.
extras
Link copied to clipboard
abstract var extras: Map<String, String>
The extras on this in-app message as a map of key value pairs.
frameColor
Link copied to clipboard
abstract var frameColor: Int?
The frame color for this in-app message.
header
Link copied to clipboard
abstract var header: String?
The header text on this in-app message.
headerTextAlign
Link copied to clipboard
abstract var headerTextAlign: TextAlign
The text alignment for the header text.
headerTextColor
Link copied to clipboard
abstract var headerTextColor: Int
The header text color on this in-app message.
icon
Link copied to clipboard
abstract var icon: String?
The Font Awesome icon on this in-app message.
iconBackgroundColor
Link copied to clipboard
abstract var iconBackgroundColor: Int
The icon background color on this in-app message.
iconColor
Link copied to clipboard
abstract var iconColor: Int
The icon color (android.graphics.Color) of this in-app message.
imageStyle
Link copied to clipboard
abstract var imageStyle: ImageStyle
The image style on this in-app message.
isControl
Link copied to clipboard
abstract val isControl: Boolean
Whether this in-app message is a control for multivariate testing.
message
Link copied to clipboard
abstract var message: String?
The message text on this in-app message.
messageButtons
Link copied to clipboard
abstract var messageButtons: List<MessageButton>
The message buttons for this in-app message.
messageTextAlign
Link copied to clipboard
abstract var messageTextAlign: TextAlign
The text alignment for the message text.
messageTextColor
Link copied to clipboard
abstract var messageTextColor: Int
The message text color on this in-app message.
messageType
Link copied to clipboard
abstract val messageType: MessageType
The MessageType of this in-app message.
openUriInWebView
Link copied to clipboard
abstract var openUriInWebView: Boolean
Sets whether to use BrazeWebViewActivity to open deep links from this in-app message.
orientation
Link copied to clipboard
abstract var orientation: Orientation
The preferred screen orientation for this in-app message.
uri
Link copied to clipboard
abstract val uri: Uri?
The URI on this in-app message.

Inheritors

InAppMessageImmersiveBase
Link copied to clipboard