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

InAppMessageSlideup

class InAppMessageSlideup : InAppMessageWithImageBase

InAppMessageSlideup is the model for slideup type in-app messages.

A slideup type in-app message extends the base in-app message with a chevron and and a slide-from field indicating from which direction the message should appear. The chevron appears on messages with a none 'None' click action, implying to users that the message can be clicked.

Constructors

InAppMessageSlideup

fun InAppMessageSlideup()

InAppMessageSlideup

fun InAppMessageSlideup(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. 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>

logClick

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.

logImpression

open override fun logImpression(): Boolean

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

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

animateIn

open override var animateIn: Boolean = true

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

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

chevronColor

@ColorInt

var chevronColor: Int

clickAction

open override val clickAction: ClickAction

The click action of this in-app message.

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.

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.

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. This will set the color of the icon background itself (not the icon itself).

iconColor

@ColorInt

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

imageDownloadSuccessful

open override var imageDownloadSuccessful: Boolean = false

The status of the image download on this in-app message. If the image specified by remoteImageUrl could not be downloaded successfully then this should return false. Returns false by default.

imageUrl

open override val imageUrl: String?

Gets the image url on this in-app message.

inAppMessageDarkThemeWrapper

var inAppMessageDarkThemeWrapper: InAppMessageTheme? = null

isControl

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.

jsonObject

var jsonObject: JSONObject? = null

localImageUrl

open override var localImageUrl: String? = null