react-native-firebase/docs/installation-ios.md

iOS Installation

Please note that there is a known issue when using Cocoapods with the use_frameworks! enabled. This is explained here. Unfortunately we don't currently have a workaround, but are engaging with Firebase directly to try and resolve the problem.

1) Link RNFirebase

Run react-native link react-native-firebase

2) Setup GoogleService-Info.plist

Setup the GoogleService-Info.plist file by following the instructions and adding it to the root of your project at ios/[YOUR APP NAME]/GoogleService-Info.plist here.

Adding the file into the directory doesn't automatically add the file to the iOS project. You need to then manually add it by doing the following:

• 2.1. Open <project root>/ios/'project name'.xcworkspace file via XCode
  • 2.1.1. If you've not got a .xcworkspace file yet then you'll need to come back to these steps after setting up your pods + pod install (step 3 on this page)
• 2.2. Right click on your project
• 2.3. Click "Add files to 'project name'"
• 2.4. Select the .plist file you copied into your project
• 2.5. Click OK

2.1) Initialisation

Make sure you've added the following to the top of your ios/[YOUR APP NAME]]/AppDelegate.m file:

#import <Firebase.h>

and this to the didFinishLaunchingWithOptions:(NSDictionary *)launchOptions method before the return statement:

[FIRApp configure];

3) Setup Firebase Pods

Firebase recommends using Cocoapods to install the Firebase SDK.

3.0) If you don't already have Cocoapods set up

Follow the instructions to install Cocoapods and create your Podfile here.

NOTE: The Podfile needs to be initialised in the ios directory of your project. Make sure to update cocoapods libs first by running pod update

Troubleshooting

1. When running pod install you may encounter an error saying that a tvOSTests target is declared twice. This appears to be a bug with pod init and the way that react native is set up.

Resolution:

• Open your Podfile
• Remove the duplicate tvOSTests target nested within the main project target
• Re-run pod install.

2. When running pod install you may encounter a number of warnings relating to target overrides 'OTHER_LDFLAGS'.

Resolution:

• Open Xcode
• Select your project
• For each target: -- Select the target -- Click Build settings -- Search for other linker flags -- Add $(inherited) as the top line if it doesn't already exist
• Re-run pod install

3. When running pod install you may encounter a warning that a default iOS platform has been assigned. If you wish to specify a different minimum version:

Resolution

• Open your Podfile
• Uncomment the # platform :ios, '9.0' line by removing the # character
• Change the version as required

3.1) Check the Podfile platform version

We recommend using a minimum platform version of at least 9.0 for your application to ensure that the correct version of the Firebase libraries are used. To do this, you need to uncomment or make sure the following line is present at the top of your Podfile:

platform :ios, '9.0'

3.2) Add the required pods

Simply add the following to your Podfile either at the top level, or within the main project target:

# Required by RNFirebase
pod 'Firebase/Core'

# [OPTIONAL PODS] - comment out pods for firebase products you won't be using.
pod 'Firebase/AdMob'
pod 'Firebase/Auth'
pod 'Firebase/Crash'
pod 'Firebase/Database'
pod 'Firebase/DynamicLinks'
pod 'Firebase/Firestore'
pod 'Firebase/Messaging'
pod 'Firebase/RemoteConfig'
pod 'Firebase/Storage'

Run pod install.

NOTE: You need to use the ios/[YOUR APP NAME].xcworkspace instead of the ios/[YOUR APP NAME].xcproj file from now on.

Troubleshooting

1. You receive an error No podspec found for 'RNFirebase'

Resolution

• Run npm install --save react-native-firebase from the root of your project

4) Cloud Messaging (optional)

If you plan on using Firebase Cloud Messaging then, you need to:

NOTE: FCM does not work on the iOS simulator, you must test is using a real device. This is a restriction enforced by Apple for some unknown reason.

4.1) Set up certificates

Follow the instructions at https://firebase.google.com/docs/cloud-messaging/ios/certs

4.2) Enable capabilities

In Xcode, enable the following capabilities:

1. Push Notifications
2. Background modes > Remote notifications

4.3) Update AppDelegate.h

Add the following import:

@import UserNotifications;

Change the interface descriptor to:

@interface AppDelegate : UIResponder <UIApplicationDelegate,UNUserNotificationCenterDelegate>

4.4) Update AppDelegate.m

Add the following import:

#import "RNFirebaseMessaging.h"

Add the following to the didFinishLaunchingWithOptions:(NSDictionary *)launchOptions method after [FIRApp Configure]:

[[UNUserNotificationCenter currentNotificationCenter] setDelegate:self];

Add the following methods:

-(void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification {
  [RNFirebaseMessaging didReceiveLocalNotification:notification];
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo {
  [RNFirebaseMessaging didReceiveRemoteNotification:userInfo];
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo
fetchCompletionHandler:(nonnull void (^)(UIBackgroundFetchResult))completionHandler{
  [RNFirebaseMessaging didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center
       willPresentNotification:(UNNotification *)notification
         withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler {
  [RNFirebaseMessaging willPresentNotification:notification withCompletionHandler:completionHandler];
}

- (void)userNotificationCenter:(UNUserNotificationCenter *)center
didReceiveNotificationResponse:(UNNotificationResponse *)response
         withCompletionHandler:(void (^)())completionHandler {
  [RNFirebaseMessaging didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
}

4.5) Debugging

If you're having problems with messages not being received, check out the following blog post for help:

https://firebase.googleblog.com/2017/01/debugging-firebase-cloud-messaging-on.html

5) Dynamic Links (optional)

If you plan on using Firebase Dynamic Links then, you need to:

5.1) Setup

Make sure to setup dynamic links for iOS as described here

5.2) create a new URL type

In the Info tab of your app's Xcode project, create a new URL type to be used for Dynamic Links. Set the Identifier field to a unique value and the URL scheme field to either your bundle identifier or a unique value.

5.3) Enable Associated Domains capability

In the Capabilities tab of your app's Xcode project, enable Associated Domains and add the following to the Associated Domains list: applinks:app_code.app.goo.gl where app_code is your dynamic links domain application code.

5.4) Update AppDelegate.m

Add the following import:

#import "RNFirebaseLinks.h"

Add the following to the didFinishLaunchingWithOptions:(NSDictionary *)launchOptions method before [FIRApp Configure]:

[FIROptions defaultOptions].deepLinkURLScheme = CUSTOM_URL_SCHEME; where CUSTOM_URL_SCHEME is the custom URL scheme you defined in your Xcode project.

In the application:openURL:sourceApplication:annotation: (for iOS 8 and older) add the following:

- (BOOL)application:(UIApplication *)app
            openURL:(NSURL *)url
            options:(NSDictionary<NSString *, id> *)options {
    return [RNFirebaseLinks application:application
                                  openURL:url
                                  options:options];
}

In the application:openURL:options: (for iOS 9) add the following:

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication
         annotation:(id)annotation {
     return [RNFirebaseLinks application:application
                                   openURL:url
                         sourceApplication:sourceApplication
                                annotation:annotation];
}

In the application:continueUserActivity:restorationHandler (Universal Links on iOS 9 and newer) add the following:

- (BOOL)application:(UIApplication *)application
continueUserActivity:(NSUserActivity *)userActivity
 restorationHandler:(void (^)(NSArray *))restorationHandler {
     return [RNFirebaseLinks application:application
                      continueUserActivity:userActivity
                        restorationHandler:restorationHandler];
}