FirebaseInAppMessaging Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
InAppMessagingPreviewHelpers
public enum InAppMessagingPreviewHelpers
Undocumented
-
Declaration
Swift
public static func cardMessage(campaignName: String = "Card message campaign",
title: String = "Title for modal message",
body: String? = "Body for modal message",
textColor: UIColor = UIColor.label,
backgroundColor: UIColor = UIColor.black,
portraitImage: UIImage = UIImage(systemName: "rectangle")!,
landscapeImage: UIImage? = UIImage(systemName: "square"),
primaryButtonText: String = "Click me!",
primaryButtonTextColor: UIColor = UIColor.systemBlue,
primaryButtonBackgroundColor: UIColor = UIColor.systemGray,
primaryActionURL: URL? = nil,
secondaryButtonText: String? = "Dismiss",
secondaryButtonTextColor: UIColor? = UIColor.secondaryLabel,
secondaryButtonBackgroundColor: UIColor? = UIColor.systemYellow,
secondaryActionURL: URL? = nil,
appData: [String: String]? = nil) -> InAppMessagingCardDisplay
-
Declaration
Swift
public static func modalMessage(campaignName: String = "Modal message campaign",
title: String = "Title for modal message",
body: String? = "Body for modal message",
textColor: UIColor = UIColor.black,
backgroundColor: UIColor = UIColor.white,
image: UIImage? = UIImage(systemName: "rectangle"),
buttonText: String? = "Click me!",
buttonTextColor: UIColor? = UIColor.systemBlue,
buttonBackgroundColor: UIColor? = UIColor
.white,
actionURL: URL? = nil,
appData: [String: String]? = nil) -> InAppMessagingModalDisplay
-
Declaration
Swift
public static func bannerMessage(campaignName: String = "Banner message campaign",
title: String = "Title for banner message",
body: String? = "Body for banner message",
textColor: UIColor = UIColor.black,
backgroundColor: UIColor = UIColor.white,
image: UIImage? = UIImage(systemName: "square"),
actionURL: URL? = nil,
appData: [String: String]? = nil)
-> InAppMessagingBannerDisplay
-
Declaration
Swift
public static func imageOnlyMessage(campaignName: String = "Image-only message campaign",
image: UIImage,
actionURL: URL? = nil,
appData: [String: String]? = nil)
-> InAppMessagingImageOnlyDisplay
-
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-04 UTC.
[null,null,["Last updated 2025-08-04 UTC."],[],[],null,["InAppMessagingPreviewHelpers \n\n public enum InAppMessagingPreviewHelpers\n\nUndocumented\n- `\n ``\n ``\n `\n\n [cardMessage(campaignName:title:body:textColor:backgroundColor:portraitImage:landscapeImage:primaryButtonText:primaryButtonTextColor:primaryButtonBackgroundColor:primaryActionURL:secondaryButtonText:secondaryButtonTextColor:secondaryButtonBackgroundColor:secondaryActionURL:appData:)](#/s:22FirebaseInAppMessaging0bcD14PreviewHelpersO11cardMessage12campaignName5title4body9textColor010backgroundN013portraitImage09landscapeQ017primaryButtonText0stuN00st10BackgroundN00S9ActionURL09secondarytU00ytuN00ytvN00ywX07appDataSo05FIRIncD11CardDisplayCSS_S2SSgSo7UIColorCAYSo7UIImageCA_SgSSA2Y10Foundation0X0VSgAwYSgA5_A4_SDyS2SGSgtFZ)`\n ` \n Undocumented \n\n Declaration \n Swift \n\n public static func cardMessage(campaignName: String = \"Card message campaign\",\n title: String = \"Title for modal message\",\n body: String? = \"Body for modal message\",\n textColor: UIColor = UIColor.label,\n backgroundColor: UIColor = UIColor.black,\n portraitImage: UIImage = UIImage(systemName: \"rectangle\")!,\n landscapeImage: UIImage? = UIImage(systemName: \"square\"),\n primaryButtonText: String = \"Click me!\",\n primaryButtonTextColor: UIColor = UIColor.systemBlue,\n primaryButtonBackgroundColor: UIColor = UIColor.systemGray,\n primaryActionURL: URL? = nil,\n secondaryButtonText: String? = \"Dismiss\",\n secondaryButtonTextColor: UIColor? = UIColor.secondaryLabel,\n secondaryButtonBackgroundColor: UIColor? = UIColor.systemYellow,\n secondaryActionURL: URL? = nil,\n appData: [String: String]? = nil) -\u003e ../Classes/InAppMessagingCardDisplay.html\n\n- `\n ``\n ``\n `\n\n [modalMessage(campaignName:title:body:textColor:backgroundColor:image:buttonText:buttonTextColor:buttonBackgroundColor:actionURL:appData:)](#/s:22FirebaseInAppMessaging0bcD14PreviewHelpersO12modalMessage12campaignName5title4body9textColor010backgroundN05image10buttonText0qrN00q10BackgroundN09actionURL7appDataSo05FIRIncD12ModalDisplayCSS_S2SSgSo7UIColorCATSo7UIImageCSgArTSgAX10Foundation0U0VSgSDyS2SGSgtFZ)`\n ` \n Undocumented \n\n Declaration \n Swift \n\n public static func modalMessage(campaignName: String = \"Modal message campaign\",\n title: String = \"Title for modal message\",\n body: String? = \"Body for modal message\",\n textColor: UIColor = UIColor.black,\n backgroundColor: UIColor = UIColor.white,\n image: UIImage? = UIImage(systemName: \"rectangle\"),\n buttonText: String? = \"Click me!\",\n buttonTextColor: UIColor? = UIColor.systemBlue,\n buttonBackgroundColor: UIColor? = UIColor\n .white,\n actionURL: URL? = nil,\n appData: [String: String]? = nil) -\u003e ../Classes/InAppMessagingModalDisplay.html\n\n- `\n ``\n ``\n `\n\n [bannerMessage(campaignName:title:body:textColor:backgroundColor:image:actionURL:appData:)](#/s:22FirebaseInAppMessaging0bcD14PreviewHelpersO13bannerMessage12campaignName5title4body9textColor010backgroundN05image9actionURL7appDataSo05FIRIncD13BannerDisplayCSS_S2SSgSo7UIColorCAQSo7UIImageCSg10Foundation0R0VSgSDyS2SGSgtFZ)`\n ` \n Undocumented \n\n Declaration \n Swift \n\n public static func bannerMessage(campaignName: String = \"Banner message campaign\",\n title: String = \"Title for banner message\",\n body: String? = \"Body for banner message\",\n textColor: UIColor = UIColor.black,\n backgroundColor: UIColor = UIColor.white,\n image: UIImage? = UIImage(systemName: \"square\"),\n actionURL: URL? = nil,\n appData: [String: String]? = nil)\n -\u003e ../Classes/InAppMessagingBannerDisplay.html\n\n- `\n ``\n ``\n `\n\n [imageOnlyMessage(campaignName:image:actionURL:appData:)](#/s:22FirebaseInAppMessaging0bcD14PreviewHelpersO16imageOnlyMessage12campaignName0G09actionURL7appDataSo05FIRIncd5ImageH7DisplayCSS_So7UIImageC10Foundation0M0VSgSDyS2SGSgtFZ)`\n ` \n Undocumented \n\n Declaration \n Swift \n\n public static func imageOnlyMessage(campaignName: String = \"Image-only message campaign\",\n image: UIImage,\n actionURL: URL? = nil,\n appData: [String: String]? = nil)\n -\u003e ../Classes/InAppMessagingImageOnlyDisplay.html\n\n- `\n ``\n ``\n `\n\n [Delegate](#/s:22FirebaseInAppMessaging0bcD14PreviewHelpersO8DelegateC)`\n ` \n Undocumented \n\n Declaration \n Swift \n\n public class Delegate : NSObject, ../Protocols/InAppMessagingDisplayDelegate.html"]]