Airship Android SDK

urbanairship-automation/com.urbanairship.iam.content/Modal

Modal

class Modal : JsonSerializable

Display content for a modal in-app message.

Types

object Companion

enum Template : Enum<Modal.Template> , JsonSerializable

Properties

allowFullscreenDisplay

val allowFullscreenDisplay: Boolean = false

A flag indicating whether the dialog is allowed to be displayed as fullscreen.

backgroundColor

val backgroundColor: InAppMessageColor

The optional banner background color.

val body: InAppMessageTextInfo? = null

The optional body InAppMessageTextInfo.

val borderRadius: Float = 0.0f

The optional border radius. Defaults to 0.

buttonLayoutType

val buttonLayoutType: InAppMessageButtonLayoutType

The optional button layout.

val buttons: List<InAppMessageButtonInfo>

The list of optional buttons.

dismissButtonColor

val dismissButtonColor: InAppMessageColor

The optional banner dismiss button color.

val footer: InAppMessageButtonInfo? = null

The optional footer button InAppMessageButtonInfo.

val heading: InAppMessageTextInfo? = null

The optional heading InAppMessageTextInfo.

val media: InAppMessageMediaInfo? = null

The optional media InAppMessageMediaInfo.

val template: Modal.Template

The optional banner Template.

Functions

fun copy(heading: InAppMessageTextInfo? = this.heading, body: InAppMessageTextInfo? = this.body, media: InAppMessageMediaInfo? = this.media, footer: InAppMessageButtonInfo? = this.footer, buttons: List<InAppMessageButtonInfo> = this.buttons, buttonLayoutType: InAppMessageButtonLayoutType = this.buttonLayoutType, template: Modal.Template = this.template, backgroundColor: InAppMessageColor = this.backgroundColor, @FloatRange(from = 0.0) borderRadius: Float = this.borderRadius, dismissButtonColor: InAppMessageColor = this.dismissButtonColor, allowFullscreenDisplay: Boolean = this.allowFullscreenDisplay): Modal

Returns a copy of the Modal display content with the provided changes.

open operator override fun equals(other: Any?): Boolean

open override fun hashCode(): Int

open override fun toJsonValue(): JsonValue

open override fun toString(): String

fun validate(): Boolean