Airship Android SDK

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

Banner

class Banner : JsonSerializable

Display content for banner in-app message.

Types

object Companion

enum Placement : Enum<Banner.Placement> , JsonSerializable

enum Template : Enum<Banner.Template> , JsonSerializable

Properties

val actions: JsonMap? = null

The action names and values to be run when the banner is clicked.

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 in dps.

buttonLayoutType

val buttonLayoutType: InAppMessageButtonLayoutType

The optional button layout.

val buttons: List<InAppMessageButtonInfo>? = null

The list of optional buttons.

dismissButtonColor

val dismissButtonColor: InAppMessageColor

The optional banner dismiss button color.

val durationMs: Long

The banner display duration. Default to 15 seconds

val heading: InAppMessageTextInfo? = null

The optional heading InAppMessageTextInfo.

val media: InAppMessageMediaInfo? = null

The optional media InAppMessageMediaInfo.

val placement: Banner.Placement

The optional banner placement. Placement

val template: Banner.Template

The optional banner Template.

Functions

fun copy(heading: InAppMessageTextInfo? = this.heading, body: InAppMessageTextInfo? = this.body, media: InAppMessageMediaInfo? = this.media, buttons: List<InAppMessageButtonInfo>? = this.buttons, buttonLayoutType: InAppMessageButtonLayoutType = this.buttonLayoutType, template: Banner.Template = this.template, backgroundColor: InAppMessageColor = this.backgroundColor, dismissButtonColor: InAppMessageColor = this.dismissButtonColor, borderRadius: Float = this.borderRadius, durationMs: Long = this.durationMs, placement: Banner.Placement = this.placement, actions: JsonMap? = this.actions): Banner

Returns a copy of the Banner 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