FirebaseInAppMessaging Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
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.
- Dynamically turning on or off data collection behavior by setting the
automaticDataCollectionEnabled property on the InAppMessaging instance to true or false.
- Setting
FirebaseInAppMessagingAutomaticDataCollectionEnabled to false in the app’s plist
file.
- Disabling data collection via the global Firebase data collection setting.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
Declaration
Objective-C
@interface FIRInAppMessaging : NSObject
-
Contains the display information for an action button. This class is unavailable on macOS,
- macOS Catalyst, and watchOS.
Declaration
Objective-C
@interface FIRInAppMessagingActionButton : NSObject
-
Contain display data for an image for a fiam message.
- This class is unavailable on macOS, macOS Catalyst, and watchOS.
Declaration
Objective-C
@interface FIRInAppMessagingImageData : 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
@interface FIRInAppMessagingCampaignInfo : NSObject
-
Defines the metadata for a FIAM action.
- This class is unavailable on macOS, macOS Catalyst, and watchOS.
Declaration
Objective-C
@interface FIRInAppMessagingAction : NSObject
-
Base class representing a FIAM message to be displayed. Don’t create instance
of this class directly. Instantiate one of its subclasses instead.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
Declaration
Objective-C
@interface FIRInAppMessagingDisplayMessage : NSObject
-
A displayable in-app card message.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
-
Class for defining a modal message for display.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
-
Class for defining a banner message for display.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
-
Class for defining a image-only message for display.
This class is unavailable on macOS, macOS Catalyst, and watchOS.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-04 UTC.
[null,null,["Last updated 2025-08-04 UTC."],[],[],null,["# FirebaseInAppMessaging Framework Reference\n\nClasses\n=======\n\nThe following classes are available globally.\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessaging](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessaging)\n\n `\n ` \n The root object for in-app messaging iOS SDK.\n\n Note: Firebase In-App Messaging depends on using a Firebase Installation ID and token pair to be\n able to retrieve messages defined for the current app instance. By default, the Firebase In-App\n Messaging SDK will obtain the ID and token pair on app/SDK startup. In its default configuration\n the in-app messaging SDK will send some device and client data (linked to the installation ID)\n to the Firebase backend periodically.\n\n The app can tune the default data collection behavior via certain controls. They are listed in\n descending order below. If a higher-priority setting exists, lower level settings are ignored.\n 1. Dynamically turning on or off data collection behavior by setting the `automaticDataCollectionEnabled` property on the `InAppMessaging` instance to true or false.\n 2. Setting `FirebaseInAppMessagingAutomaticDataCollectionEnabled` to false in the app's plist file.\n 3. Disabling data collection via the global Firebase data collection setting.\n\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessaging : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingActionButton](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingActionButton)\n\n `\n ` \n Contains the display information for an action button. This class is unavailable on macOS,\n - macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingActionButton : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingImageData](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingImageData)\n\n `\n ` \n Contain display data for an image for a fiam message.\n - This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingImageData : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingCampaignInfo](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingCampaignInfo)\n\n `\n ` \n Defines the metadata for the campaign to which a FIAM message belongs.\n - This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingCampaignInfo : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingAction](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingAction)\n\n `\n ` \n Defines the metadata for a FIAM action.\n - This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingAction : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingDisplayMessage](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingDisplayMessage)\n\n `\n ` \n Base class representing a FIAM message to be displayed. Don't create instance\n of this class directly. Instantiate one of its subclasses instead.\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingDisplayMessage : NSObject\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingCardDisplay](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingCardDisplay)\n\n `\n ` \n A displayable in-app card message.\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingCardDisplay : /docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingDisplayMessage\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingModalDisplay](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingModalDisplay)\n\n `\n ` \n Class for defining a modal message for display.\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingModalDisplay : /docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingDisplayMessage\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingBannerDisplay](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingBannerDisplay)\n\n `\n ` \n Class for defining a banner message for display.\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingBannerDisplay : /docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingDisplayMessage\n\n- `\n ``\n ``\n `\n\n ### [FIRInAppMessagingImageOnlyDisplay](/docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingImageOnlyDisplay)\n\n `\n ` \n Class for defining a image-only message for display.\n This class is unavailable on macOS, macOS Catalyst, and watchOS. \n\n #### Declaration\n\n Objective-C \n\n\n @interface FIRInAppMessagingImageOnlyDisplay : /docs/reference/ios/firebaseinappmessaging/api/reference/Classes/FIRInAppMessagingDisplayMessage"]]
