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
Link copied to clipboard
open fun InAppMessageSlideup()
InAppMessageSlideup
Link copied to clipboard
open fun InAppMessageSlideup(object: JSONObject, appboyManager: IBrazeManager)
if JSON is malformed.
InAppMessageSlideup
Link copied to clipboard
private open fun InAppMessageSlideup(object: JSONObject, appboyManager: IBrazeManager, slideFrom: SlideFrom, chevronColor: Int)

Functions

enableDarkTheme
Link copied to clipboard
open fun enableDarkTheme()
Instructs the IInAppMessage to apply any dark theme settings and override any existing values present on the IInAppMessage.
forJsonPut
Link copied to clipboard
open fun forJsonPut(): JSONObject
Storing in-app messages serialized with this method is primarily for storage as triggered actions.
getAnimateIn
Link copied to clipboard
open fun getAnimateIn(): Null
Whether this in-app message will animate in or appear suddenly.
getAnimateOut
Link copied to clipboard
open fun getAnimateOut(): Null
Whether this in-app message will animate out or disappear suddenly.
getBackgroundColor
Link copied to clipboard
open fun getBackgroundColor(): Null
The android.graphics.Color background color on this in-app message.
getBitmap
Link copied to clipboard
open fun getBitmap(): Null
The bitmap on this in-app message.
getBrazeManager
Link copied to clipboard
fun getBrazeManager(): Null
getChevronColor
Link copied to clipboard
open fun getChevronColor(): Int
getClickAction
Link copied to clipboard
open fun getClickAction(): Null
The click action of this in-app message.
getCropType
Link copied to clipboard
open fun getCropType(): Null
The crop type for this in-app message's image.
getDismissType
Link copied to clipboard
open fun getDismissType(): Null
The dismiss type of this in-app message.
getDurationInMilliseconds
Link copied to clipboard
open fun getDurationInMilliseconds(): Null
Gets the duration of this in-app message.
getExpirationTimestamp
Link copied to clipboard
open fun getExpirationTimestamp(): Null
Expiration timestamp is not stored locally since it changes dynamically depending on trigger time.
getExtras
Link copied to clipboard
open fun getExtras(): Null
The extras on this in-app message as a map of key value pairs.
getIcon
Link copied to clipboard
open fun getIcon(): Null
The Font Awesome icon on this in-app message.
getIconBackgroundColor
Link copied to clipboard
open fun getIconBackgroundColor(): Null
The icon background color on this in-app message.
getIconColor
Link copied to clipboard
open fun getIconColor(): Null
The icon color (android.graphics.Color) of this in-app message.
getImageDownloadSuccessful
Link copied to clipboard
open fun getImageDownloadSuccessful(): Null
The status of the image download on this in-app message.
getImageUrl
Link copied to clipboard
open fun getImageUrl(): Null
Gets the image url on this in-app message.
getInAppMessageDarkThemeWrapper
Link copied to clipboard
fun getInAppMessageDarkThemeWrapper(): Null
getJsonObject
Link copied to clipboard
fun getJsonObject(): Null
getLocalImageUrl
Link copied to clipboard
open fun getLocalImageUrl(): Null
The local uri of this in-app message image.
getLocalPrefetchedAssetPaths
Link copied to clipboard
open fun getLocalPrefetchedAssetPaths(): Null
Gets where to find the pre-fetched remote assets specified in setLocalPrefetchedAssetPaths.
getMessage
Link copied to clipboard
open fun getMessage(): Null
The message text on this in-app message.
getMessageTextAlign
Link copied to clipboard
open fun getMessageTextAlign(): Null
The text alignment for the message text.
getMessageTextColor
Link copied to clipboard
open fun getMessageTextColor(): Null
The message text color on this in-app message.
getMessageType
Link copied to clipboard
open fun getMessageType(): MessageType
The MessageType of this in-app message.
getOpenUriInWebView
Link copied to clipboard
open fun getOpenUriInWebView(): Null
Sets whether to use BrazeWebViewActivity to open deep links from this in-app message.
getOrientation
Link copied to clipboard
open fun getOrientation(): Null
The preferred screen orientation for this in-app message.
getRemoteAssetPathsForPrefetch
Link copied to clipboard
open fun getRemoteAssetPathsForPrefetch(): Null
getRemoteImageUrl
Link copied to clipboard
open fun getRemoteImageUrl(): Null
The remote uri of this in-app message image.
getSlideFrom
Link copied to clipboard
open fun getSlideFrom(): SlideFrom
getTriggerId
Link copied to clipboard
fun getTriggerId(): Null
getUri
Link copied to clipboard
open fun getUri(): Null
The URI on this in-app message.
isControl
Link copied to clipboard
open fun isControl(): Null
Whether this in-app message is a control for multivariate testing.
logClick
Link copied to clipboard
open fun logClick(): Null
Logs a click on this in-app message.
logDisplayFailure
Link copied to clipboard
open fun logDisplayFailure(failureType: Null): Null
Logs a display failure on this in-app message.
logImpression
Link copied to clipboard
open fun logImpression(): Null
Logs an impression on this in-app message.
onAfterClosed
Link copied to clipboard
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
Link copied to clipboard
open fun setAnimateIn(animateIn: Boolean)
Whether this in-app message will animate in or appear suddenly.
setAnimateOut
Link copied to clipboard
open fun setAnimateOut(animateOut: Boolean)
Whether this in-app message will animate out or disappear suddenly.
setBackgroundColor
Link copied to clipboard
open fun setBackgroundColor(backgroundColor: Int)
The android.graphics.Color background color on this in-app message.
setBitmap
Link copied to clipboard
open fun setBitmap(bitmap: Bitmap)
The bitmap on this in-app message.
setBrazeManager
Link copied to clipboard
fun setBrazeManager(brazeManager: IBrazeManager)
setChevronColor
Link copied to clipboard
open fun setChevronColor(chevronColor: Int)
setClickBehavior
Link copied to clipboard
open fun setClickBehavior(clickAction: ClickAction)
Convenience method that calls
setCropType
Link copied to clipboard
open fun setCropType(cropType: CropType)
The crop type for this in-app message's image.
setDismissType
Link copied to clipboard
open fun setDismissType(dismissType: DismissType)
The dismiss type of this in-app message.
setDurationInMilliseconds
Link copied to clipboard
open fun setDurationInMilliseconds(value: Int)
Gets the duration of this in-app message.
setExpirationTimestamp
Link copied to clipboard
open fun setExpirationTimestamp(expirationTimestamp: Long)
Expiration timestamp is not stored locally since it changes dynamically depending on trigger time.
setExtras
Link copied to clipboard
open fun setExtras(extras: Map<String, String>)
The extras on this in-app message as a map of key value pairs.
setIcon
Link copied to clipboard
open fun setIcon(icon: String)
The Font Awesome icon on this in-app message.
setIconBackgroundColor
Link copied to clipboard
open fun setIconBackgroundColor(iconBackgroundColor: Int)
The icon background color on this in-app message.
setIconColor
Link copied to clipboard
open fun setIconColor(iconColor: Int)
The icon color (android.graphics.Color) of this in-app message.
setImageDownloadSuccessful
Link copied to clipboard
open fun setImageDownloadSuccessful(imageDownloadSuccessful: Boolean)
The status of the image download on this in-app message.
setInAppMessageDarkThemeWrapper
Link copied to clipboard
fun setInAppMessageDarkThemeWrapper(inAppMessageDarkThemeWrapper: InAppMessageTheme)
setJsonObject
Link copied to clipboard
fun setJsonObject(jsonObject: JSONObject)
setLocalImageUrl
Link copied to clipboard
open fun setLocalImageUrl(localImageUrl: String)
The local uri of this in-app message image.
setLocalPrefetchedAssetPaths
Link copied to clipboard
open fun setLocalPrefetchedAssetPaths(remotePathToLocalAssetMap: Null)
The base In-App Message class does not have assets of its own.
setMessage
Link copied to clipboard
open fun setMessage(message: String)
The message text on this in-app message.
setMessageTextAlign
Link copied to clipboard
open fun setMessageTextAlign(messageTextAlign: TextAlign)
The text alignment for the message text.
setMessageTextColor
Link copied to clipboard
open fun setMessageTextColor(messageTextColor: Int)
The message text color on this in-app message.
setOpenUriInWebView
Link copied to clipboard
open fun setOpenUriInWebView(openUriInWebView: Boolean)
Sets whether to use BrazeWebViewActivity to open deep links from this in-app message.
setOrientation
Link copied to clipboard
open fun setOrientation(orientation: Orientation)
The preferred screen orientation for this in-app message.
setRemoteImageUrl
Link copied to clipboard
open fun setRemoteImageUrl(remoteImageUrl: String)
The remote uri of this in-app message image.
setSlideFrom
Link copied to clipboard
open fun setSlideFrom(slideFrom: SlideFrom)

Properties

CHEVRON_COLOR
Link copied to clipboard
private val CHEVRON_COLOR: String
mChevronColor
Link copied to clipboard
private open val mChevronColor: Int
mSlideFrom
Link copied to clipboard
private open val mSlideFrom: SlideFrom
SLIDE_FROM
Link copied to clipboard
private val SLIDE_FROM: String
TAG
Link copied to clipboard
private val TAG: String