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

InAppMessage

actual abstract class InAppMessage(source)

A message to display: a BannerMessage, CardMessage, ImageOnlyMessage or ModalMessage, as its messageType says. The deprecated members are the Android SDK's message-independent getters.

Inheritors

expect abstract class InAppMessage(source)

A message to display: a BannerMessage, CardMessage, ImageOnlyMessage or ModalMessage, as its messageType says. The deprecated members are the Android SDK's message-independent getters.

Inheritors

actual abstract class InAppMessage(source)

Parameters

native

The platform SDK's message this one was built from: the iOS SDK's FIRInAppMessagingDisplayMessage on Apple platforms, which the display callbacks and the default UI hand back to the iOS SDK.

Inheritors

Properties

Link copied to clipboard
actual abstract val action: Action?

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

expect abstract val action: Action?

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

actual abstract val action: Action?

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

Link copied to clipboard
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.

Link copied to clipboard
actual open val backgroundHexColor: String?

The background color of this message.

expect open val backgroundHexColor: String?

The background color of this message.

actual open val backgroundHexColor: String?

The background color of this message.

Link copied to clipboard
actual open val body: Text?

The body of this message.

expect open val body: Text?

The body of this message.

actual open val body: Text?

The body of this message.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard
actual open val imageData: ImageData?

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

expect open val imageData: ImageData?

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

actual open val imageData: ImageData?

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

Link copied to clipboard
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.

Link copied to clipboard
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).

Link copied to clipboard
@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.

Link copied to clipboard
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.

Link copied to clipboard
actual open val title: Text?

The title of this message.

expect open val title: Text?

The title of this message.

actual open val title: Text?

The title of this message.

Generated by Dokka
firebase-multiplatform, Apache License 2.0. Based on GitLive's firebase-kotlin-sdk.