FirebaseInAppMessagingDisplay Framework Reference

FIRInAppMessagingModalDisplay


@interface FIRInAppMessagingModalDisplay : FIRInAppMessagingDisplayMessage

Class for defining a modal message for display.

  • Gets the title for a modal fiam message.

    Declaration

    Objective-C

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

  • Gets the image data for a modal fiam message.

    Declaration

    Objective-C

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

  • Gets the body text for a modal fiam message.

    Declaration

    Objective-C

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

  • Gets the action button metadata for a modal fiam message.

    Declaration

    Objective-C

    @property (readonly, nonatomic, nullable)
    FIRInAppMessagingActionButton *actionButton;

  • Gets the action URL for a modal fiam message.

    Declaration

    Objective-C

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

  • Gets the background color for a modal fiam message.

    Declaration

    Objective-C

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

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

    Declaration

    Objective-C

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

  • 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
           actionButton:(nullable FIRInAppMessagingActionButton *)actionButton
              actionURL:(nullable NSURL *)actionURL;