IInAppMessage

interface IInAppMessage : IPutIntoJson<JSONObject>

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

Functions

forJsonPut

abstract fun forJsonPut(): JSONObject

getLocalPrefetchedAssetPaths

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

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

getRemoteAssetPathsForPrefetch

abstract fun getRemoteAssetPathsForPrefetch(): List<String>

Returns a path to remote assets that can be pre-fetched.

logClick

abstract fun logClick(): Boolean

Logs a click on this in-app message.

logDisplayFailure

abstract fun logDisplayFailure(failureType: InAppMessageFailureType): Boolean

Logs a display failure on this in-app message.

logImpression

abstract fun logImpression(): Boolean

Logs an impression on this in-app message.

onAfterClosed

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

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.

setLocalPrefetchedAssetPaths

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

abstract var animateIn: Boolean

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

animateOut

abstract var animateOut: Boolean

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

backgroundColor

abstract var backgroundColor: Int

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

clickAction

abstract val clickAction: ClickAction

The click action of this in-app message.

cropType

abstract var cropType: CropType

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

dismissType

abstract var dismissType: DismissType

The dismiss type of this in-app message.

durationInMilliseconds

abstract var durationInMilliseconds: Int

Gets the duration of this in-app message.

expirationTimestamp

abstract var expirationTimestamp: Long

The UTC timestamp at which this message expires and will not be displayed.

extras

abstract var extras: Map<String, String>

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

icon

abstract var icon: String?

The Font Awesome icon on this in-app message.

iconBackgroundColor

abstract var iconBackgroundColor: Int

The icon background color on this in-app message.

iconColor

abstract var iconColor: Int

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

isControl

abstract val isControl: Boolean

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

message

abstract var message: String?

The message text on this in-app message.

messageTextAlign

abstract var messageTextAlign: TextAlign

The text alignment for the message text.

messageTextColor

abstract 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

abstract var openUriInWebView: Boolean

Sets whether to use BrazeWebViewActivity to open deep links from this in-app message.

orientation

abstract var orientation: Orientation

The preferred screen orientation for this in-app message.

uri

abstract val uri: Uri?

The URI on this in-app message.

Inheritors

IInAppMessageHtml

IInAppMessageImmersive

InAppMessageBase