In App Messaging Models Module v1.0.0/com.salesforce.marketingcloud.inappmessaging.models/InAppMessage

InAppMessage

data class InAppMessage(val id: String, val priority: Int = 999, val startDateUtc: Date? = null, val endDateUtc: Date? = null, val modifiedDateUtc: Date? = null, val displayLimit: Int = 1, val displayCount: Int = 0, val type: InAppMessage.Type, val windowColor: String? = null, val displayDuration: Long = -1, val backgroundColor: String?, val cornerRadius: InAppMessage.Size = Size.s, val layoutOrder: InAppMessage.LayoutOrder = LayoutOrder.ImageTitleBody, val media: InAppMessage.Media? = null, val title: InAppMessage.TextField? = null, val body: InAppMessage.TextField? = null, val tertiaryText: InAppMessage.TertiaryTextField? = null, val closeButton: InAppMessage.CloseButton? = null, val buttonConfiguration: InAppMessage.ButtonConfig = ButtonConfig.twoUp, val buttons: List<InAppMessage.Button>? = null, val messageDelaySec: Int = 0, val displaySuppressionAction: List<String>? = null, val shadow: InAppMessage.Shadow? = null, val additionalMargin: InAppMessage.Margin? = null, val animation: InAppMessage.Animation? = null, val border: InAppMessage.Border? = null, val appLimitOverride: Boolean = false, val source: Event.Producer) : Parcelable

Constructors

constructor(id: String, priority: Int = 999, startDateUtc: Date? = null, endDateUtc: Date? = null, modifiedDateUtc: Date? = null, displayLimit: Int = 1, displayCount: Int = 0, type: InAppMessage.Type, windowColor: String? = null, displayDuration: Long = -1, backgroundColor: String?, cornerRadius: InAppMessage.Size = Size.s, layoutOrder: InAppMessage.LayoutOrder = LayoutOrder.ImageTitleBody, media: InAppMessage.Media? = null, title: InAppMessage.TextField? = null, body: InAppMessage.TextField? = null, tertiaryText: InAppMessage.TertiaryTextField? = null, closeButton: InAppMessage.CloseButton? = null, buttonConfiguration: InAppMessage.ButtonConfig = ButtonConfig.twoUp, buttons: List<InAppMessage.Button>? = null, messageDelaySec: Int = 0, displaySuppressionAction: List<String>? = null, shadow: InAppMessage.Shadow? = null, additionalMargin: InAppMessage.Margin? = null, animation: InAppMessage.Animation? = null, border: InAppMessage.Border? = null, appLimitOverride: Boolean = false, source: Event.Producer)

Types

enum Alignment : Enum<InAppMessage.Alignment>

data class Animation(val type: InAppMessage.Animation.AnimationType? = null, val duration: Int = 450) : Parcelable

data class Border(val width: InAppMessage.Size = Size.s, val color: String? = null) : Parcelable

data class Button(val id: String, val index: Int = 0, val text: String, val actionType: InAppMessage.Button.ActionType = ActionType.close, val action: String? = null, val backgroundColor: String? = null, val cornerRadius: InAppMessage.Size = Size.s, val font: InAppMessage.Font? = null, val border: InAppMessage.Border? = null, val margin: InAppMessage.Margin? = null, val additionalMargin: InAppMessage.Margin? = null, val textAlignment: InAppMessage.TextAlignment = TextAlignment.center, val shadow: InAppMessage.Shadow? = null) : Parcelable

enum ButtonConfig : Enum<InAppMessage.ButtonConfig>

data class CloseButton(val alignment: InAppMessage.Alignment = Alignment.end, val iconColor: String? = null, val backgroundColor: String? = null, val additionalMargin: InAppMessage.Margin? = null) : Parcelable

enum ContentMode : Enum<InAppMessage.ContentMode>

data class Font(val size: InAppMessage.Size = Size.s, val color: String? = null, val style: InAppMessage.Font.FontStyle? = null, val fontFamily: String? = null) : Parcelable

enum LayoutOrder : Enum<InAppMessage.LayoutOrder>

data class Margin(val top: InAppMessage.Size? = null, val bottom: InAppMessage.Size? = null, val left: InAppMessage.Size? = null, val right: InAppMessage.Size? = null) : Parcelable

data class Media(val url: String, val size: InAppMessage.Media.ImageSize = ImageSize.e2e, val altText: String? = null, val cornerRadius: InAppMessage.Size = Size.s, val altMedia: String? = null, val insetSize: InAppMessage.Size? = null, val border: InAppMessage.Border? = null, val shadow: InAppMessage.Shadow? = null, val margin: InAppMessage.Margin? = null, val additionalMargin: InAppMessage.Margin? = null, val aspectRatio: String = DEFAULT_ASPECT_RATIO, val contentMode: InAppMessage.ContentMode = ContentMode.fill) : Parcelable

data class Shadow(val length: InAppMessage.Size? = null, val color: String? = null) : Parcelable

enum Size : Enum<InAppMessage.Size>

TertiaryTextField

data class TertiaryTextField(val text: String, val alignment: InAppMessage.Alignment = Alignment.center, val font: InAppMessage.Font? = null, val margin: InAppMessage.Margin? = null, val additionalMargin: InAppMessage.Margin? = null, val hyperlinks: List<String>? = null, val linkColor: String? = null) : Parcelable

enum TextAlignment : Enum<InAppMessage.TextAlignment>

data class TextField(val text: String, val alignment: InAppMessage.Alignment = Alignment.center, val font: InAppMessage.Font? = null, val margin: InAppMessage.Margin? = null, val additionalMargin: InAppMessage.Margin? = null) : Parcelable

enum Type : Enum<InAppMessage.Type>

Properties

additionalMargin

val additionalMargin: InAppMessage.Margin?

val animation: InAppMessage.Animation?

appLimitOverride

val appLimitOverride: Boolean

backgroundColor

val backgroundColor: String?

val body: InAppMessage.TextField?

val border: InAppMessage.Border?

buttonConfiguration

val buttonConfiguration: InAppMessage.ButtonConfig

val buttons: List<InAppMessage.Button>?

val closeButton: InAppMessage.CloseButton?

val cornerRadius: InAppMessage.Size

val displayCount: Int

displayDuration

val displayDuration: Long

val displayLimit: Int

displaySuppressionAction

val displaySuppressionAction: List<String>?

val endDateUtc: Date?

val layoutOrder: InAppMessage.LayoutOrder

val media: InAppMessage.Media?

messageDelaySec

val messageDelaySec: Int

modifiedDateUtc

val modifiedDateUtc: Date?

val priority: Int

val shadow: InAppMessage.Shadow?

val source: Event.Producer

val startDateUtc: Date?

val tertiaryText: InAppMessage.TertiaryTextField?

val title: InAppMessage.TextField?

val type: InAppMessage.Type

val windowColor: String?