FirebaseInAppMessaging Framework Reference

FIRInAppMessagingCardDisplay


@interface FIRInAppMessagingCardDisplay : FIRInAppMessagingDisplayMessage

A displayable in-app card message. This class is unavailable on macOS, macOS Catalyst, and watchOS.

  • Gets the title text for a card FIAM message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *title;
  • Gets the body text for a card FIAM message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *body;
  • Gets the color for text in card FIAM message. It applies to both title and body text.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) UIColor *textColor;
  • Image data for the supplied portrait image for a card FIAM messasge.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) FIRInAppMessagingImageData *portraitImageData;
  • Image data for the supplied landscape image for a card FIAM message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) FIRInAppMessagingImageData *landscapeImageData;
  • The background color for a card FIAM message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) UIColor *displayBackgroundColor;
  • Metadata for a card FIAM message’s primary action button.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nonnull) FIRInAppMessagingActionButton *primaryActionButton;
  • The action URL for a card FIAM message’s primary action button.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSURL *primaryActionURL;
  • Metadata for a card FIAM message’s secondary action button.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) FIRInAppMessagingActionButton *secondaryActionButton;
  • The action URL for a card FIAM message’s secondary action button.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSURL *secondaryActionURL;
  • Unavailable.

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Exposed for unit testing only, or for use in SwiftUI previews. Don’t instantiate this in your app directly.

    Declaration

    Objective-C

    - (nonnull instancetype)
         initWithCampaignName:(nonnull NSString *)campaignName
                    titleText:(nonnull NSString *)title
                     bodyText:(nullable NSString *)bodyText
                    textColor:(nonnull UIColor *)textColor
            portraitImageData:
                (nonnull FIRInAppMessagingImageData *)portraitImageData
           landscapeImageData:
               (nullable FIRInAppMessagingImageData *)landscapeImageData
              backgroundColor:(nonnull UIColor *)backgroundColor
          primaryActionButton:
              (nonnull FIRInAppMessagingActionButton *)primaryActionButton
        secondaryActionButton:
            (nullable FIRInAppMessagingActionButton *)secondaryActionButton
             primaryActionURL:(nullable NSURL *)primaryActionURL
           secondaryActionURL:(nullable NSURL *)secondaryActionURL
                      appData:(nullable NSDictionary *)appData;