FirebaseInAppMessaging Framework Reference

Classes

The following classes are available globally.

  • The root object for in-app messaging iOS SDK.

    Note: Firebase In-App Messaging depends on using a Firebase Installation ID and token pair to be able to retrieve messages defined for the current app instance. By default, the Firebase In-App Messaging SDK will obtain the ID and token pair on app/SDK startup. In its default configuration the in-app messaging SDK will send some device and client data (linked to the installation ID) to the Firebase backend periodically.

    The app can tune the default data collection behavior via certain controls. They are listed in descending order below. If a higher-priority setting exists, lower level settings are ignored.

    1. Dynamically turning on or off data collection behavior by setting theautomaticDataCollectionEnabled property on theInAppMessaging instance to true or false.
    2. SettingFirebaseInAppMessagingAutomaticDataCollectionEnabled to false in the app’s plist file.
    3. Disabling data collection via the global Firebase data collection setting.

    This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessaging:NSObject

  • Contains the display information for an action button. This class is unavailable on macOS,

    • macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingActionButton:NSObject

  • Contain display data for an image for a fiam message.

    • This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingImageData:NSObject

  • Defines the metadata for the campaign to which a FIAM message belongs.

    • This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingCampaignInfo:NSObject

  • Defines the metadata for a FIAM action.

    • This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingAction:NSObject

  • Base class representing a FIAM message to be displayed. Don’t create instanceof this class directly. Instantiate one of its subclasses instead.This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingDisplayMessage:NSObject

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

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingCardDisplay:FIRInAppMessagingDisplayMessage

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

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingModalDisplay:FIRInAppMessagingDisplayMessage

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

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingBannerDisplay:FIRInAppMessagingDisplayMessage

  • Class for defining a image-only message for display.This class is unavailable on macOS, macOS Catalyst, and watchOS.

    Declaration

    Objective-C

    @interfaceFIRInAppMessagingImageOnlyDisplay:FIRInAppMessagingDisplayMessage

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-04 UTC.