InAppMessageSlideup

open 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

open fun InAppMessageSlideup()

InAppMessageSlideup

open fun InAppMessageSlideup(object: JSONObject, appboyManager: IBrazeManager)

if JSON is malformed.

InAppMessageSlideup

private open fun InAppMessageSlideup(object: JSONObject, appboyManager: IBrazeManager, slideFrom: SlideFrom, chevronColor: Int)

Functions

enableDarkTheme

open fun enableDarkTheme()

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

forJsonPut

open fun forJsonPut(): JSONObject

Storing in-app messages serialized with this method is primarily for storage as triggered actions.

getAnimateIn

open fun getAnimateIn(): Null

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

getAnimateOut

open fun getAnimateOut(): Null

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

getBackgroundColor

open fun getBackgroundColor(): Null

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

getBitmap

open fun getBitmap(): Null

The bitmap on this in-app message.

getBrazeManager

fun getBrazeManager(): Null

getChevronColor

open fun getChevronColor(): Int

getClickAction

open fun getClickAction(): Null

The click action of this in-app message.

getCropType

open fun getCropType(): Null

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

getDismissType

open fun getDismissType(): Null

The dismiss type of this in-app message.

getDurationInMilliseconds

open fun getDurationInMilliseconds(): Null

Gets the duration of this in-app message.

getExpirationTimestamp

open fun getExpirationTimestamp(): Null

Expiration timestamp is not stored locally since it changes dynamically depending on trigger time.

getExtras

open fun getExtras(): Null

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

getIcon

open fun getIcon(): Null

The Font Awesome icon on this in-app message.

getIconBackgroundColor

open fun getIconBackgroundColor(): Null

The icon background color on this in-app message.

getIconColor

open fun getIconColor(): Null

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

getImageDownloadSuccessful

open fun getImageDownloadSuccessful(): Null

The status of the image download on this in-app message.

getImageUrl

open fun getImageUrl(): Null

Gets the image url on this in-app message.

getInAppMessageDarkThemeWrapper

fun getInAppMessageDarkThemeWrapper(): Null

getJsonObject

fun getJsonObject(): Null

getLocalImageUrl

open fun getLocalImageUrl(): Null

The local uri of this in-app message image.

getLocalPrefetchedAssetPaths

open fun getLocalPrefetchedAssetPaths(): Null

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

getMessage

open fun getMessage(): Null

The message text on this in-app message.

getMessageTextAlign

open fun getMessageTextAlign(): Null

The text alignment for the message text.

getMessageTextColor

open fun getMessageTextColor(): Null

The message text color on this in-app message.

getMessageType

@NonNull()

open fun getMessageType(): MessageType

The MessageType of this in-app message.

getOpenUriInWebView

open fun getOpenUriInWebView(): Null

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

getOrientation

open fun getOrientation(): Null

The preferred screen orientation for this in-app message.

getRemoteAssetPathsForPrefetch

open fun getRemoteAssetPathsForPrefetch(): Null

getRemoteImageUrl

open fun getRemoteImageUrl(): Null

The remote uri of this in-app message image.

getSlideFrom

open fun getSlideFrom(): SlideFrom

getTriggerId

fun getTriggerId(): Null

getUri

open fun getUri(): Null

The URI on this in-app message.

isControl

open fun isControl(): Null

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

logClick

open fun logClick(): Null

Logs a click on this in-app message.

logDisplayFailure

open fun logDisplayFailure(failureType: Null): Null

Logs a display failure on this in-app message.

logImpression

open fun logImpression(): Null

Logs an impression on this in-app message.

onAfterClosed

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

setAnimateIn

open fun setAnimateIn(animateIn: Boolean)

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

setAnimateOut

open fun setAnimateOut(animateOut: Boolean)

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

setBackgroundColor

open fun setBackgroundColor(backgroundColor: Int)

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

setBitmap

open fun setBitmap(bitmap: Bitmap)

The bitmap on this in-app message.

setBrazeManager

fun setBrazeManager(brazeManager: IBrazeManager)

setChevronColor

open fun setChevronColor(chevronColor: Int)

setClickBehavior

open fun setClickBehavior(clickAction: ClickAction)

Convenience method that calls

setCropType

open fun setCropType(cropType: CropType)

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

setDismissType

open fun setDismissType(dismissType: DismissType)

The dismiss type of this in-app message.

setDurationInMilliseconds

open fun setDurationInMilliseconds(value: Int)

Gets the duration of this in-app message.

setExpirationTimestamp

open fun setExpirationTimestamp(expirationTimestamp: Long)

Expiration timestamp is not stored locally since it changes dynamically depending on trigger time.

setExtras

open fun setExtras(extras: Map<String, String>)

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

setIcon

open fun setIcon(icon: String)

The Font Awesome icon on this in-app message.

setIconBackgroundColor

open fun setIconBackgroundColor(iconBackgroundColor: Int)

The icon background color on this in-app message.

setIconColor

open fun setIconColor(iconColor: Int)

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

setImageDownloadSuccessful

open fun setImageDownloadSuccessful(imageDownloadSuccessful: Boolean)

The status of the image download on this in-app message.

setInAppMessageDarkThemeWrapper

fun setInAppMessageDarkThemeWrapper(inAppMessageDarkThemeWrapper: InAppMessageTheme)

setJsonObject

fun setJsonObject(jsonObject: JSONObject)

setLocalImageUrl

open fun setLocalImageUrl(localImageUrl: String)

The local uri of this in-app message image.

setLocalPrefetchedAssetPaths

open fun setLocalPrefetchedAssetPaths(remotePathToLocalAssetMap: Null)

The base In-App Message class does not have assets of its own.

setMessage

open fun setMessage(message: String)

The message text on this in-app message.

setMessageTextAlign

open fun setMessageTextAlign(messageTextAlign: TextAlign)

The text alignment for the message text.

setMessageTextColor

open fun setMessageTextColor(messageTextColor: Int)

The message text color on this in-app message.

setOpenUriInWebView

open fun setOpenUriInWebView(openUriInWebView: Boolean)

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

setOrientation

open fun setOrientation(orientation: Orientation)

The preferred screen orientation for this in-app message.

setRemoteImageUrl

open fun setRemoteImageUrl(remoteImageUrl: String)

The remote uri of this in-app message image.

setSlideFrom

open fun setSlideFrom(slideFrom: SlideFrom)

Properties

CHEVRON_COLOR

private val CHEVRON_COLOR: String

mChevronColor

@ColorInt()

private open val mChevronColor: Int

mSlideFrom

private open val mSlideFrom: SlideFrom

SLIDE_FROM

private val SLIDE_FROM: String

TAG

private val TAG: String