IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

CardMessage

class CardMessage : InAppMessage

kotlin.Any
↳	com.google.firebase.inappmessaging.model.InAppMessage
	↳	com.google.firebase.inappmessaging.model.CardMessage

Encapsulates a Firebase In App Card Message.

Summary

Public functions
`Action?`	`getAction()` This function is deprecated. Use `getPrimaryAction` or `getSecondaryAction` instead.
`ImageData?`	`getImageData()` This function is deprecated. Use `getPortraitImageData` or `getLandscapeImageData` instead.

Public functions

Action?

getAction()

This function is deprecated.

Use getPrimaryAction or getSecondaryAction instead.

ImageData?

getImageData()

This function is deprecated.

Use getPortraitImageData or getLandscapeImageData instead.

Public properties
`String`	`backgroundHexColor`
`Text?`	`body`
`ImageData?`	`landscapeImageData`
`ImageData?`	`portraitImageData`
`Action`	`primaryAction`
`Action?`	`secondaryAction`
`Text`	`title` !!!!!WARNING!!!!! We are overriding equality in this class.

Inherited functions

From com.google.firebase.inappmessaging.model.InAppMessage

`Button?`	`getActionButton()` This function is deprecated. Use the message specific methods (see `CardMessage`, `ModalMessage`, `BannerMessage`, `ImageOnlyMessage`) instead.
`String?`	`getCampaignId()` This function is deprecated. Use `getCampaignMetadata` instead.
`CampaignMetadata?`	`getCampaignMetadata()` Gets the `CampaignMetadata` of the message
`String?`	`getCampaignName()` This function is deprecated. Use `getCampaignMetadata` instead.
`(Mutable)Map<String!, String!>?`	`getData()` Gets the extra data map of the message.
`String?`	`getImageUrl()` This function is deprecated. Use the message specific methods (see `CardMessage`, `ModalMessage`, `BannerMessage`, `ImageOnlyMessage`) instead.
`Boolean?`	`getIsTestMessage()` This function is deprecated. Use `getCampaignMetadata` instead.
`MessageType?`	`getMessageType()` Gets the `MessageType` of the message

Inherited properties

From com.google.firebase.inappmessaging.model.InAppMessage

`Button!`	`actionButton`
`String!`	`campaignId`
`CampaignMetadata!`	`campaignMetadata`
`String!`	`campaignName`
`(Mutable)Map<String!, String!>?`	`data`
`String!`	`imageUrl`
`Boolean!`	`isTestMessage`
`MessageType!`	`messageType`

Public functions

getAction

fun getAction(): Action?

getImageData

fun getImageData(): ImageData?

Public properties

backgroundHexColor

val backgroundHexColor: String

body

val body: Text?

landscapeImageData

val landscapeImageData: ImageData?

portraitImageData

val portraitImageData: ImageData?

primaryAction

val primaryAction: Action

secondaryAction

val secondaryAction: Action?

title

val title: Text

!!!!!WARNING!!!!! We are overriding equality in this class. Please add equality checks for all new private class members.