FirebaseInAppMessagingDisplay Framework Reference

FIRInAppMessagingBannerDisplay


@interface FIRInAppMessagingBannerDisplay : FIRInAppMessagingDisplayMessage

Class for defining a banner message for display.

  • Gets the title of a banner message.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nonnull) NSString *title;
  • Gets the image data for a banner message.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable)
        FIRInAppMessagingImageData *imageData;
  • Gets the body text for a banner message.

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, nullable) NSString *bodyText;
  • Gets banner’s background color

    Declaration

    Objective-C

    @property (readonly, copy, nonatomic, 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 (readwrite, copy, nonatomic, nonnull) UIColor *textColor;
  • Gets the action URL for a banner fiam message.

    Declaration

    Objective-C

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

    Declaration

    Objective-C

    - (nonnull instancetype)init;
  • Deprecated, this class shouldn’t be directly instantiated.

    Declaration

    Objective-C

    - (nonnull instancetype)
          initWithMessageID:(nonnull NSString *)messageID
               campaignName:(nonnull NSString *)campaignName
        renderAsTestMessage:(BOOL)renderAsTestMessage
                triggerType:(FIRInAppMessagingDisplayTriggerType)triggerType
                  titleText:(nonnull NSString *)title
                   bodyText:(nonnull NSString *)bodyText
                  textColor:(nonnull UIColor *)textColor
            backgroundColor:(nonnull UIColor *)backgroundColor
                  imageData:(nullable FIRInAppMessagingImageData *)imageData
                  actionURL:(nullable NSURL *)actionURL;