firebase-inappmessaging/com.google.firebase.inappmessaging.model/BannerMessage

BannerMessage

actual class BannerMessage : InAppMessage(source)

A banner message, shown at the top of the screen.

expect class BannerMessage : InAppMessage(source)

A banner message, shown at the top of the screen.

actual class BannerMessage : InAppMessage(source)

A banner message, shown at the top of the screen.

Properties

actual open override val action: Action?

The action of this message; for a CardMessage its primary action.

expect open override val action: Action?

The action of a click on the banner, if any.

actual open override val action: Action?

The action of this message; for a CardMessage its primary action.

actual open val ~~actionButton~~: Button?

The button of action, if any.

expect open val ~~actionButton~~: Button?

The button of action, if any.

actual open val ~~actionButton~~: Button?

The button of action, if any.

backgroundHexColor

actual open override val backgroundHexColor: String

The background color of this message.

expect open override val backgroundHexColor: String

The background color.

actual open override val backgroundHexColor: String

The background color of this message.

actual open override val body: Text?

The body of this message.

expect open override val body: Text?

The body, if any.

actual open override val body: Text?

The body of this message.

actual open val ~~campaignId~~: String?

The id of the campaign; CampaignMetadata.campaignId.

expect open val ~~campaignId~~: String?

The id of the campaign; CampaignMetadata.campaignId.

actual open val ~~campaignId~~: String?

The id of the campaign; CampaignMetadata.campaignId.

campaignMetadata

actual val campaignMetadata: CampaignMetadata?

The campaign this message belongs to.

expect val campaignMetadata: CampaignMetadata?

The campaign this message belongs to.

actual val campaignMetadata: CampaignMetadata?

The campaign this message belongs to.

actual open val ~~campaignName~~: String?

The name of the campaign; CampaignMetadata.campaignName.

expect open val ~~campaignName~~: String?

The name of the campaign; CampaignMetadata.campaignName.

actual open val ~~campaignName~~: String?

The name of the campaign; CampaignMetadata.campaignName.

actual val data: Map<String, String>?

The custom key-value data of the campaign.

expect val data: Map<String, String>?

The custom key-value data of the campaign.

actual val data: Map<String, String>?

The custom key-value data of the campaign.

actual open override val imageData: ImageData?

The image of this message; for a CardMessage its portrait image.

expect open override val imageData: ImageData?

The image, if any.

actual open override val imageData: ImageData?

The image of this message; for a CardMessage its portrait image.

actual open val ~~imageUrl~~: String?

The image URL of a message created by an old version of the Android SDK: always null for the messages the SDK creates now, on Android as well. Use the image data of the specific message type.

expect open val ~~imageUrl~~: String?

The image URL of a message created by an old version of the Android SDK: always null for the messages the SDK creates now, on Android as well. Use the image data of the specific message type.

actual open val ~~imageUrl~~: String?

The image URL of a message created by an old version of the Android SDK: always null for the messages the SDK creates now, on Android as well. Use the image data of the specific message type.

val InAppMessage.ios: FIRInAppMessagingDisplayMessage?

The iOS SDK's message this one was built from, a FIRInAppMessagingCardDisplay, FIRInAppMessagingModalDisplay, FIRInAppMessagingBannerDisplay or FIRInAppMessagingImageOnlyDisplay. It has what the Android model lacks, such as the trigger type and the downloaded image data (imageRawData).

@get:JvmName(name = "getIsTestMessage")

actual val ~~isTestMessage~~: Boolean?

Whether this is a test message; CampaignMetadata.isTestMessage.

expect val ~~isTestMessage~~: Boolean?

Whether this is a test message; CampaignMetadata.isTestMessage.

@get:JvmName(name = "getIsTestMessage")

actual val ~~isTestMessage~~: Boolean?

Whether this is a test message; CampaignMetadata.isTestMessage.

actual val messageType: MessageType?

The type of this message.

expect val messageType: MessageType?

The type of this message.

actual val messageType: MessageType?

The type of this message.

actual open override val title: Text

The title of this message.

expect open override val title: Text

The title.

actual open override val title: Text

The title of this message.

Functions

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

open override fun hashCode(): Int

open override fun toString(): String