Blog Studio Go to console

FirebaseInAppMessaging Framework Reference

FIRInAppMessagingBannerDisplay


@interface FIRInAppMessagingBannerDisplay : FIRInAppMessagingDisplayMessage

Class for defining a banner message for display. This class is unavailable on macOS, macOS Catalyst, and watchOS.

  • Gets the title of a banner message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) NSString *title;

  • Gets the image data for a banner message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) FIRInAppMessagingImageData *imageData;

  • Gets the body text for a banner message.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nullable) NSString *bodyText;

  • Gets banner’s background color

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) UIColor *displayBackgroundColor;

  • Gets the color for text in banner fiam message. It would apply to both title and body text.

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly, nonnull) UIColor *textColor;

  • Gets the action URL for a banner fiam message.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) NSURL *actionURL;

  • Unavailable

    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
         backgroundColor:(nonnull UIColor *)backgroundColor
               imageData:(nullable FIRInAppMessagingImageData *)imageData
               actionURL:(nullable NSURL *)actionURL
                 appData:(nullable NSDictionary *)appData;