README.md 29.1 KB
Newer Older
Libin Lu's avatar
Libin Lu committed
1 2
[![Join the chat at https://gitter.im/evollu/react-native-fcm](https://badges.gitter.im/evollu/react-native-fcm.svg)](https://gitter.im/evollu/react-native-fcm?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

3
## NOTES:
Libin Lu's avatar
Libin Lu committed
4
- current latest version: v10.x
Libin Lu's avatar
Libin Lu committed
5
- for iOS SDK < 4, use react-native-fcm@6.2.3 (v6.x is still compatible with Firebase SDK v4)
6 7 8
- for RN < 0.40.0, use react-native-fcm@2.5.6
- for RN < 0.33.0, use react-native-fcm@1.1.0
- for RN < 0.30.0, use react-native-fcm@1.0.15
Libin Lu's avatar
Libin Lu committed
9
- local notification is not only available in V1
Libin Lu's avatar
Libin Lu committed
10

11
- An example working project is available at: https://github.com/evollu/react-native-fcm/tree/master/Examples/simple-fcm-client
Libin Lu's avatar
Libin Lu committed
12

Libin Lu's avatar
Libin Lu committed
13 14
- DO NOT change Android targetSdkVersion >= 26. The notification won't show up because of notification channel requirement.
If you have to upgrade, you can use sdk-26 branch and post feedback on [here](https://github.com/evollu/react-native-fcm/pull/699)
Libin Lu's avatar
Libin Lu committed
15

Libin Lu's avatar
init  
Libin Lu committed
16 17 18
## Installation

- Run `npm install react-native-fcm --save`
Libin Lu's avatar
Libin Lu committed
19
- Run `react-native link react-native-fcm` (RN 0.29.1+, otherwise `rnpm link react-native-fcm`). Or you can do [manual linking](https://facebook.github.io/react-native/docs/linking-libraries-ios.html#manual-linking) which is more reliable
Libin Lu's avatar
init  
Libin Lu committed
20

Libin Lu's avatar
Libin Lu committed
21 22 23 24
## Configure Firebase Console
### FCM config file

In [firebase console](https://console.firebase.google.com/), you can:
Sean Adkinson's avatar
Sean Adkinson committed
25
- for **Android**: download `google-services.json` file and place it in `android/app` directory
Libin Lu's avatar
Libin Lu committed
26 27 28 29 30
- for **iOS**: download `GoogleService-Info.plist` file and place it in `/ios/your-project-name` directory (next to your `Info.plist`)

Make sure you have certificates setup by following
https://firebase.google.com/docs/cloud-messaging/ios/certs

31
## Android Configuration
Libin Lu's avatar
init  
Libin Lu committed
32

Libin Lu's avatar
Libin Lu committed
33 34 35 36
- As `react-native link` sometimes has glitches, make sure you have this line added

https://github.com/evollu/react-native-fcm/blob/master/Examples/simple-fcm-client/android/app/src/main/java/com/google/firebase/quickstart/fcm/MainApplication.java#L28

37 38 39 40 41
- Edit `android/build.gradle`:
```diff
  dependencies {
    classpath 'com.android.tools.build:gradle:2.0.0'
+   classpath 'com.google.gms:google-services:3.0.0'
Libin Lu's avatar
init  
Libin Lu committed
42 43
```

Sagiv Ofek's avatar
Sagiv Ofek committed
44
- Edit `android/app/build.gradle`. Add at the bottom of the file:
45 46
```diff
  apply plugin: "com.android.application"
KazuyaKitahara's avatar
KazuyaKitahara committed
47
  ...
48
+ apply plugin: 'com.google.gms.google-services'
Libin Lu's avatar
init  
Libin Lu committed
49 50
```

51
- Edit `android/app/src/main/AndroidManifest.xml`:
Libin Lu's avatar
init  
Libin Lu committed
52

53 54 55 56 57
```diff
  <application
    ...
    android:theme="@style/AppTheme">

Libin Lu's avatar
Libin Lu committed
58
+   <service android:name="com.evollu.react.fcm.MessagingService" android:enabled="true" android:exported="true">
59 60 61 62 63 64 65 66 67 68 69 70
+     <intent-filter>
+       <action android:name="com.google.firebase.MESSAGING_EVENT"/>
+     </intent-filter>
+   </service>

+   <service android:name="com.evollu.react.fcm.InstanceIdService" android:exported="false">
+     <intent-filter>
+       <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
+     </intent-filter>
+   </service>

    ...
Libin Lu's avatar
init  
Libin Lu committed
71
```
72

Libin Lu's avatar
Libin Lu committed
73 74 75
- Edit `{YOUR_MAIN_PROJECT}/app/build.gradle`:
```diff
 dependencies {
76
+    compile project(':react-native-fcm')
Libin Lu's avatar
Libin Lu committed
77 78 79 80 81 82
+    compile 'com.google.firebase:firebase-core:10.0.1' //this decides your firebase SDK version
     compile fileTree(dir: "libs", include: ["*.jar"])
     compile "com.android.support:appcompat-v7:23.0.1"
     compile "com.facebook.react:react-native:+"  // From node_modules
 }
```
Ashish Chaudhary's avatar
Ashish Chaudhary committed
83
- Edit `android/settings.gradle`
84 85 86 87 88 89
```diff
  ...
+ include ':react-native-fcm'
+ project(':react-native-fcm').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-fcm/android')
  include ':app'
```
Libin Lu's avatar
Libin Lu committed
90

91
### Config for notification and `click_action` in Android
92 93 94 95 96 97 98 99 100 101 102 103 104

To allow android to respond to `click_action`, you need to define Activities and filter on specific intent. Since all javascript is running in MainActivity, you can have MainActivity to handle actions:

Edit `AndroidManifest.xml`:

```diff
  <activity
    android:name=".MainActivity"
    android:label="@string/app_name"
    android:windowSoftInputMode="adjustResize"
+   android:launchMode="singleTop"
    android:configChanges="keyboard|keyboardHidden|orientation|screenSize">
    <intent-filter>
105 106
      <action android:name="android.intent.action.MAIN" />
      <category android:name="android.intent.category.LAUNCHER" />
107 108
    </intent-filter>
  </activity>
109
```
110 111

Notes:
Libin Lu's avatar
Libin Lu committed
112
- `launchMode="singleTop"` is to reuse MainActivity, you can use `singleTask` or `singleInstance` as well depend on your need. [this link explains the behavior well](https://blog.mindorks.com/android-activity-launchmode-explained-cbc6cf996802)
Libin Lu's avatar
Libin Lu committed
113
- you if want to handle `click_action` you need to add custom intent-filter, check native android documentation
114 115


116
If you are using RN < 0.30.0 and react-native-fcm < 1.0.16, pass intent into package, edit `MainActivity.java`:
117

Libin Lu's avatar
Libin Lu committed
118
- RN 0.28:
119 120 121 122 123 124 125 126 127 128 129 130 131 132

```diff
  import com.facebook.react.ReactActivity;
+ import android.content.Intent;

  public class MainActivity extends ReactActivity {

+   @Override
+   public void onNewIntent (Intent intent) {
+     super.onNewIntent(intent);
+       setIntent(intent);
+   }       
```

Libin Lu's avatar
Libin Lu committed
133
NOTE: Verify that react-native links correctly in `MainApplication.java`
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154

```diff
import android.app.application
...
+import com.evollu.react.fcm.FIRMessagingPackage;
```
....
```diff
    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
          new MainReactPackage(),
          new VectorIconsPackage(),
+         new FIRMessagingPackage(),
          new RNDeviceInfo(),
      );
    }
 ```   



155 156 157 158 159 160 161 162 163 164 165 166 167
- RN <= 0.27:

```diff
  import com.facebook.react.ReactActivity;
+ import android.content.Intent;

  public class MainActivity extends ReactActivity {

+   @Override
+   protected void onNewIntent (Intent intent) {
+     super.onNewIntent(intent);
+       setIntent(intent);
+   }       
168
```
Libin Lu's avatar
init  
Libin Lu committed
169

170 171 172
Notes:
- `@Override` is added to update intent on notification click

173
## IOS Configuration
Libin Lu's avatar
init  
Libin Lu committed
174

Libin Lu's avatar
Libin Lu committed
175 176
### Pod approach:

177
Make sure you have [Cocoapods](https://cocoapods.org/) version > 1.0
178

179
Configure the project:
Libin Lu's avatar
Libin Lu committed
180 181
```
cd ios && pod init
182 183 184 185 186 187 188 189 190 191 192 193 194
```

(In case of syntax errors, `open YOURApp.xcodeproj/project.pbxproj` and fix them.)

Edit the newly created `Podfile`:
```diff
  # Pods for YOURAPP
+ pod 'FirebaseMessaging'
```

Install the `Firebase/Messaging` pod:
```
pod install
Libin Lu's avatar
Libin Lu committed
195
```
Libin Lu's avatar
Libin Lu committed
196
NOTE: you don't need to enable `use_frameworks!`. if you have to have `use_frameworks!` make sure you don't have `inherit! :search_paths`
Libin Lu's avatar
init  
Libin Lu committed
197

Libin Lu's avatar
Libin Lu committed
198
### Non Cocoapod approach
199

Libin Lu's avatar
Libin Lu committed
200 201
1. Download the Firebase SDK framework from [Integrate without CocoaPods](https://firebase.google.com/docs/ios/setup#frameworks).
- Import libraries, add Capabilities (background running and push notification), upload APNS and etc etc etc...
Libin Lu's avatar
Libin Lu committed
202
2. Put frameworks under `ios/Frameworks` folder
203
2. Follow the `README` to link frameworks (Analytics+Messaging)
Libin Lu's avatar
Libin Lu committed
204 205

### Shared steps
Libin Lu's avatar
Libin Lu committed
206

Libin Lu's avatar
Libin Lu committed
207 208
Edit `AppDelegate.h`:
```diff
Libin Lu's avatar
Libin Lu committed
209 210
+ @import UserNotifications;
+
Libin Lu's avatar
Libin Lu committed
211 212 213
+ @interface AppDelegate : UIResponder <UIApplicationDelegate,UNUserNotificationCenterDelegate>
- @interface AppDelegate : UIResponder <UIApplicationDelegate>
```
Libin Lu's avatar
init  
Libin Lu committed
214

215 216 217 218 219 220 221 222 223
Edit `AppDelegate.m`:
```diff
+ #import "RNFIRMessaging.h"
  //...

  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
  {
  //...
+   [FIRApp configure];
Libin Lu's avatar
Libin Lu committed
224
+   [[UNUserNotificationCenter currentNotificationCenter] setDelegate:self];
225 226 227

    return YES;
 }
Sean Adkinson's avatar
Sean Adkinson committed
228

Libin Lu's avatar
Libin Lu committed
229
+
Libin Lu's avatar
Libin Lu committed
230
+ - (void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions))completionHandler
Libin Lu's avatar
Libin Lu committed
231
+ {
Libin Lu's avatar
Libin Lu committed
232
+   [RNFIRMessaging willPresentNotification:notification withCompletionHandler:completionHandler];
Libin Lu's avatar
Libin Lu committed
233
+ }
Libin Lu's avatar
Libin Lu committed
234
+
Libin Lu's avatar
Libin Lu committed
235
+ #if defined(__IPHONE_11_0)
Libin Lu's avatar
Libin Lu committed
236
+ - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler
Libin Lu's avatar
Libin Lu committed
237
+ {
Libin Lu's avatar
Libin Lu committed
238
+   [RNFIRMessaging didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
Libin Lu's avatar
Libin Lu committed
239
+ }
Libin Lu's avatar
Libin Lu committed
240 241 242 243 244 245
+ #else
+ - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void(^)())completionHandler
+ {
+   [RNFIRMessaging didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
+ }
+ #endif
Libin Lu's avatar
Libin Lu committed
246
+
Libin Lu's avatar
Libin Lu committed
247
+ //You can skip this method if you don't want to use local notification
Libin Lu's avatar
Libin Lu committed
248
+ -(void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification {
Libin Lu's avatar
Libin Lu committed
249
+   [RNFIRMessaging didReceiveLocalNotification:notification];
Libin Lu's avatar
Libin Lu committed
250
+ }
251
+
Libin Lu's avatar
Libin Lu committed
252
+ - (void)application:(UIApplication *)application didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo fetchCompletionHandler:(nonnull void (^)(UIBackgroundFetchResult))completionHandler{
Libin Lu's avatar
Libin Lu committed
253
+   [RNFIRMessaging didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
254 255
+ }
```
256

Libin Lu's avatar
Libin Lu committed
257
### Add Capabilities
258 259 260
- Select your project **Capabilities** and enable:
  - **Push Notifications**
  - *Background Modes* > **Remote notifications**.
261

Libin Lu's avatar
Libin Lu committed
262
### FirebaseAppDelegateProxyEnabled
Libin Lu's avatar
Libin Lu committed
263
This instruction assumes that you have FirebaseAppDelegateProxyEnabled=YES (default) so that Firebase will hook on push notification registration events. If you turn this flag off, you will be on your own to manage APNS tokens and link with Firebase token.
Libin Lu's avatar
Libin Lu committed
264

Libin Lu's avatar
Libin Lu committed
265
## Setup Local Notifications
Libin Lu's avatar
Libin Lu committed
266
NOTE: local notification does NOT have any dependency on FCM library but you still need to include Firebase to compile. If there are enough demand to use this functionality alone, I will separate it out into another repo
Libin Lu's avatar
Libin Lu committed
267

Libin Lu's avatar
Libin Lu committed
268
### IOS
Libin Lu's avatar
Libin Lu committed
269
No change required
270

Libin Lu's avatar
Libin Lu committed
271
### Android
Libin Lu's avatar
Libin Lu committed
272 273 274 275 276
Edit AndroidManifest.xml
```diff
  <uses-permission android:name="android.permission.INTERNET" />
+ <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
+ <uses-permission android:name="android.permission.VIBRATE" />
277

Libin Lu's avatar
Libin Lu committed
278
  <application
Libin Lu's avatar
Libin Lu committed
279
+    <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@mipmap/ic_notif"/>
Libin Lu's avatar
Libin Lu committed
280 281 282 283 284 285 286 287 288 289
+      <receiver android:name="com.evollu.react.fcm.FIRLocalMessagingPublisher"/>
+      <receiver android:enabled="true" android:exported="true"  android:name="com.evollu.react.fcm.FIRSystemBootEventReceiver">
+          <intent-filter>
+              <action android:name="android.intent.action.BOOT_COMPLETED"/>
+              <action android:name="android.intent.action.QUICKBOOT_POWERON"/>
+              <action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
+              <category android:name="android.intent.category.DEFAULT" />
+          </intent-filter>
+      </receiver>
  </application>
290
```
Libin Lu's avatar
Libin Lu committed
291 292
NOTE: `com.evollu.react.fcm.FIRLocalMessagingPublisher` is required for presenting local notifications. `com.evollu.react.fcm.FIRSystemBootEventReceiver` is required only if you need to schedule future or recurring local notifications

Libin Lu's avatar
init  
Libin Lu committed
293

Libin Lu's avatar
Libin Lu committed
294
## Usage
Libin Lu's avatar
init  
Libin Lu committed
295 296

```javascript
Sarath's avatar
Sarath committed
297
import {Platform} from 'react-native';
Libin Lu's avatar
Libin Lu committed
298
import FCM, {FCMEvent, RemoteNotificationResult, WillPresentNotificationResult, NotificationType} from 'react-native-fcm';
Goran Gajic's avatar
Goran Gajic committed
299

Libin Lu's avatar
Libin Lu committed
300 301 302 303 304 305 306
// this shall be called regardless of app state: running, background or not running. Won't be called when app is killed by user in iOS
FCM.on(FCMEvent.Notification, async (notif) => {
    // there are two parts of notif. notif.notification contains the notification payload, notif.data contains data payload
    if(notif.local_notification){
      //this is a local notification
    }
    if(notif.opened_from_tray){
Libin Lu's avatar
Libin Lu committed
307 308
      //iOS: app is open/resumed because user clicked banner
      //Android: app is open/resumed because user clicked banner or tapped app icon
Libin Lu's avatar
Libin Lu committed
309
    }
Libin Lu's avatar
Libin Lu committed
310
    // await someAsyncCall();
Libin Lu's avatar
Libin Lu committed
311 312 313

    if(Platform.OS ==='ios'){
      //optional
Libin Lu's avatar
Libin Lu committed
314
      //iOS requires developers to call completionHandler to end notification process. If you do not call it your background remote notifications could be throttled, to read more about it see https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623013-application.
Libin Lu's avatar
Libin Lu committed
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
      //This library handles it for you automatically with default behavior (for remote notification, finish with NoData; for WillPresent, finish depend on "show_in_foreground"). However if you want to return different result, follow the following code to override
      //notif._notificationType is available for iOS platfrom
      switch(notif._notificationType){
        case NotificationType.Remote:
          notif.finish(RemoteNotificationResult.NewData) //other types available: RemoteNotificationResult.NewData, RemoteNotificationResult.ResultFailed
          break;
        case NotificationType.NotificationResponse:
          notif.finish();
          break;
        case NotificationType.WillPresent:
          notif.finish(WillPresentNotificationResult.All) //other types available: WillPresentNotificationResult.None
          break;
      }
    }
});
FCM.on(FCMEvent.RefreshToken, (token) => {
    console.log(token)
    // fcm token may not be available on first load, catch it here
});
        
335
class App extends Component {
Libin Lu's avatar
Libin Lu committed
336
    componentDidMount() {
Libin Lu's avatar
Libin Lu committed
337 338 339 340
        // iOS: show permission prompt for the first call. later just check permission in user settings
        // Android: check permission in user settings
        FCM.requestPermissions().then(()=>console.log('granted')).catch(()=>console.log('notification permission rejected'));
        
Libin Lu's avatar
Libin Lu committed
341 342 343 344
        FCM.getFCMToken().then(token => {
            console.log(token)
            // store fcm token in your server
        });
Libin Lu's avatar
Libin Lu committed
345
        
Libin Lu's avatar
Libin Lu committed
346
        this.notificationListener = FCM.on(FCMEvent.Notification, async (notif) => {
Libin Lu's avatar
Libin Lu committed
347
            // optional, do some component related stuff
Libin Lu's avatar
Libin Lu committed
348
        });
Libin Lu's avatar
Libin Lu committed
349
        
Libin Lu's avatar
Libin Lu committed
350 351
        // initial notification contains the notification that launchs the app. If user launchs app by clicking banner, the banner notification info will be here rather than through FCM.on event
        // sometimes Android kills activity when app goes to background, and when resume it broadcasts notification before JS is run. You can use FCM.getInitialNotification() to capture those missed events.
Libin Lu's avatar
Libin Lu committed
352
        // initial notification will be triggered all the time even when open app by icon so send some action identifier when you send notification
Alex Dunne's avatar
Alex Dunne committed
353
        FCM.getInitialNotification().then(notif => {
Libin Lu's avatar
Libin Lu committed
354 355
           console.log(notif)
        });
Libin Lu's avatar
Libin Lu committed
356
    }
Goran Gajic's avatar
Goran Gajic committed
357

Libin Lu's avatar
Libin Lu committed
358
    componentWillUnmount() {
359 360
        // stop listening for events
        this.notificationListener.remove();
Libin Lu's avatar
Libin Lu committed
361
    }
362

Libin Lu's avatar
Libin Lu committed
363
    otherMethods(){
364

Libin Lu's avatar
Libin Lu committed
365 366 367 368 369 370 371 372
        FCM.subscribeToTopic('/topics/foo-bar');
        FCM.unsubscribeFromTopic('/topics/foo-bar');
        FCM.presentLocalNotification({
            id: "UNIQ_ID_STRING",                               // (optional for instant notification)
            title: "My Notification Title",                     // as FCM payload
            body: "My Notification Message",                    // as FCM payload (required)
            sound: "default",                                   // as FCM payload
            priority: "high",                                   // as FCM payload
Libin Lu's avatar
Libin Lu committed
373 374 375
            click_action: "ACTION",                             // as FCM payload
            badge: 10,                                          // as FCM payload IOS only, set 0 to clear badges
            number: 10,                                         // Android only
Libin Lu's avatar
Libin Lu committed
376 377
            ticker: "My Notification Ticker",                   // Android only
            auto_cancel: true,                                  // Android only (default true)
Libin Lu's avatar
Libin Lu committed
378
            large_icon: "ic_launcher",                           // Android only
Libin Lu's avatar
Libin Lu committed
379
            icon: "ic_launcher",                                // as FCM payload, you can relace this with custom icon you put in mipmap
Libin Lu's avatar
Libin Lu committed
380 381 382
            big_text: "Show when notification is expanded",     // Android only
            sub_text: "This is a subText",                      // Android only
            color: "red",                                       // Android only
Libin Lu's avatar
Libin Lu committed
383
            vibrate: 300,                                       // Android only default: 300, no vibration if you pass 0
Libin Lu's avatar
Libin Lu committed
384
            wake_screen: true,                                  // Android only, wake up screen when notification arrives
Libin Lu's avatar
Libin Lu committed
385
            group: "group",                                     // Android only
Libin Lu's avatar
Libin Lu committed
386
            picture: "https://google.png",                      // Android only bigPicture style
Libin Lu's avatar
Libin Lu committed
387
            ongoing: true,                                      // Android only
Libin Lu's avatar
Libin Lu committed
388
            my_custom_data:'my_custom_field_value',             // extra data you want to throw
389
            lights: true,                                       // Android only, LED blinking (default false)
Libin Lu's avatar
Libin Lu committed
390
            show_in_foreground                                  // notification when app is in foreground (local & remote)
Libin Lu's avatar
Libin Lu committed
391
        });
392

Libin Lu's avatar
Libin Lu committed
393
        FCM.scheduleLocalNotification({
Libin Lu's avatar
Libin Lu committed
394
            fire_date: new Date().getTime(),      //RN's converter is used, accept epoch time and whatever that converter supports
Libin Lu's avatar
Libin Lu committed
395
            id: "UNIQ_ID_STRING",    //REQUIRED! this is what you use to lookup and delete notification. In android notification with same ID will override each other
Libin Lu's avatar
Libin Lu committed
396 397
            body: "from future past",
            repeat_interval: "week" //day, hour
Libin Lu's avatar
Libin Lu committed
398
        })
Libin Lu's avatar
Libin Lu committed
399 400

        FCM.getScheduledLocalNotifications().then(notif=>console.log(notif));
401

Libin Lu's avatar
Libin Lu committed
402 403 404
        //these clears notification from notification center/tray
        FCM.removeAllDeliveredNotifications()
        FCM.removeDeliveredNotification("UNIQ_ID_STRING")
405

Libin Lu's avatar
Libin Lu committed
406 407 408
        //these removes future local notifications
        FCM.cancelAllLocalNotifications()
        FCM.cancelLocalNotification("UNIQ_ID_STRING")
409

Libin Lu's avatar
Libin Lu committed
410 411
        FCM.setBadgeNumber(1);                                       // iOS and supporting android.
        FCM.getBadgeNumber().then(number=>console.log(number));     // iOS and supporting android.
412
        FCM.send('984XXXXXXXXX', {
413
          my_custom_data_1: 'my_custom_field_value_1',
414 415
          my_custom_data_2: 'my_custom_field_value_2'
        });
Sean Adkinson's avatar
Sean Adkinson committed
416

417 418 419 420 421 422
        FCM.deleteInstanceId()
            .then( () => {
              //Deleted instance id successfully
              //This will reset Instance ID and revokes all tokens.
            })
            .catch(error => {
Sean Adkinson's avatar
Sean Adkinson committed
423
              //Error while deleting instance id
424
            });
Libin Lu's avatar
Libin Lu committed
425
    }
426
}
Libin Lu's avatar
init  
Libin Lu committed
427 428
```

Lucas Bento's avatar
Lucas Bento committed
429
### Build custom push notification for Android
Libin Lu's avatar
Libin Lu committed
430 431
Firebase android misses important feature of android notification like `group`, `priority` and etc. As a work around you can send data message (no `notification` payload at all) and this repo will build a local notification for you. If you pass `custom_notification` in the payload, the repo will treat the content as a local notification config and shows immediately.

Libin Lu's avatar
Libin Lu committed
432
NOTE: By using this work around, you will have to send different types of payload for iOS and Android devices because custom_notification isn't supported on iOS
Libin Lu's avatar
Libin Lu committed
433 434

WARNING: `custom_notification` **cannot** be used together with `notification` attribute. use `data` **ALONE**
Libin Lu's avatar
Libin Lu committed
435 436 437 438 439 440 441 442

Example of payload that is sent to FCM server:
```
{
  "to":"FCM_TOKEN",
  "data": {
    "type":"MEASURE_CHANGE",
    "custom_notification": {
Libin Lu's avatar
Libin Lu committed
443
      "body": "test body",
Libin Lu's avatar
Libin Lu committed
444 445 446 447 448
      "title": "test title",
      "color":"#00ACD4",
      "priority":"high",
      "icon":"ic_notif",
      "group": "GROUP",
Libin Lu's avatar
Libin Lu committed
449 450
      "id": "id",
      "show_in_foreground": true
Libin Lu's avatar
Libin Lu committed
451 452 453 454 455 456 457
    }
  }
}
```

Check local notification guide below for configuration.

Sean Adkinson's avatar
Sean Adkinson committed
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
**IMPORTANT**: When using the `admin.messaging` API, you need to `JSON.stringify` the `custom_notification` value:

```
let tokens = [...];
let payload = {
  data: {
    custom_notification: JSON.stringify({
      body: 'Message body',
      title: 'Message title'
      ...
    })
  }
};
let options = { priority: "high" };

admin
  .messaging()
  .sendToDevice(tokens, payload, options);
```

478
### Behaviour when sending `notification` and `data` payload through GCM
Libin Lu's avatar
Libin Lu committed
479
- When user clicks notification to **launch** the application, you can get that notification by calling `FCM.getInitialNotification`. (NOTE: reloading javascript or resuming from background won't change the value)
Libin Lu's avatar
Libin Lu committed
480

Libin Lu's avatar
Libin Lu committed
481 482 483 484 485
- When app is running in background (the tricky one, I strongly suggest you try it out yourself)
 - IOS will receive notificaton from `FCMNotificationReceived` event
    * if you pass `content_available` flag true, you will receive one when app is in background and another one when user resume the app. [more info](http://www.rahuljiresal.com/2015/03/retract-push-notifications-on-ios/)
    * if you just pass `notification`, you will only receive one when user resume the app.
    * you will not see banner if `notification->body` is not defined.
486
 - Android will receive notificaton from `FCMNotificationReceived` event
Naisheel Verdhan's avatar
Naisheel Verdhan committed
487
    * if you pass `notification` payload, it will receive data when user click on notification
488 489 490 491 492
    * if you pass `data` payload only, it will receive data when in background

   e.g. fcm payload looks like:

   ```json
Libin Lu's avatar
Libin Lu committed
493 494 495 496 497 498 499 500 501 502 503 504 505
   {
      "to":"some_device_token",
      "content_available": true,
      "notification": {
          "title": "hello",
          "body": "yo",
          "click_action": "fcm.ACTION.HELLO"
      },
      "data": {
          "extra":"juice"
      }
    }
    ```
506 507

    and event callback will receive as:
508

509 510 511 512
    - Android
      ```json
      {
        "fcm": {"action": "fcm.ACTION.HELLO"},
Libin Lu's avatar
Libin Lu committed
513
        "opened_from_tray": 1,
514 515 516
        "extra": "juice"
      }
      ```
517

518 519 520 521
    - iOS
      ```json
      {
        "apns": {"action_category": "fcm.ACTION.HELLO"},
Libin Lu's avatar
Libin Lu committed
522
        "opened_from_tray": 1,
523 524 525
        "extra": "juice"
      }
      ```
526

Libin Lu's avatar
Libin Lu committed
527
- When app is running in foreground
Naisheel Verdhan's avatar
Naisheel Verdhan committed
528
 - IOS will receive notification and android **won't** (better not to do anything in foreground for hybrid and send a separate data message.)
529

Naisheel Verdhan's avatar
Naisheel Verdhan committed
530
NOTE: it is recommended not to rely on `data` payload for click_action as it can be overwritten (check [this](http://stackoverflow.com/questions/33738848/handle-multiple-notifications-with-gcm)).
531

532 533 534 535 536
### Quick notes about upstream messages
If your app server implements the [XMPP Connection Server](https://firebase.google.com/docs/cloud-messaging/server#implementing-the-xmpp-connection-server-protocol) protocol, it can receive upstream messages from a user's device to the cloud. To initiate an upstream message, call the `FCM.send()` method with your Firebase `Sender ID` and a `Data Object` as parameters as follows:

```javascript
FCM.send('984XXXXXXXXX', {
537
  my_custom_data_1: 'my_custom_field_value_1',
538 539 540 541 542 543
  my_custom_data_2: 'my_custom_field_value_2'
});
```

The `Data Object` is message data comprising as many key-value pairs of the message's payload as are needed (ensure that the value of each pair in the data object is a `string`). Your `Sender ID` is a unique numerical value generated when you created your Firebase project, it is available in the `Cloud Messaging` tab of the Firebase console `Settings` pane. The sender ID is used to identify each app server that can send messages to the client app.

Libin Lu's avatar
init  
Libin Lu committed
544
## Q & A
545

Libin Lu's avatar
Libin Lu committed
546 547 548 549 550 551
#### Why do you build another local notification
Yes there are `react-native-push-notification` and `react-native-system-notification` which are great libraries. However
- We want a unified local notification library but people are reporting using react-native-push-notification with this repo has compatibility issue as `react-native-push-notification` also sets up GCM.
- We want to have local notification to have similar syntax as remote notification payload.
- The PushNotificationIOS by react native team is still missing features that recurring, so we are adding it here

552
#### My Android build is failing
Libin Lu's avatar
Libin Lu committed
553 554 555 556 557 558 559 560 561 562 563 564 565
Try update your SDK and google play service. If you are having multiple plugins requiring different version of play-service sdk, use force to lock in version
```
dependencies {
    ...
    compile ('com.android.support:appcompat-v7:25.0.1') {
        exclude group: 'com.google.android', module: 'support-v4'
    }
    compile ('com.google.android.gms:play-services-gcm:10.0.1') {
        force = true;
    }
   ...
}
```
566

Libin Lu's avatar
Libin Lu committed
567 568
#### My App throws FCM function undefined error
There seems to be link issue with rnpm. Make sure that there is `new FIRMessagingPackage(),` in your `Application.java` file
Libin Lu's avatar
Libin Lu committed
569

Libin Lu's avatar
Libin Lu committed
570 571
#### I can't get notification in iOS emulator
Remote notification can't reach iOS emulator since it can't fetch APNS token. Use real device.
572

Libin Lu's avatar
Libin Lu committed
573 574 575 576
#### I'm not getting notfication when app is in background
1. Make sure you've uploaded APNS certificates to Firebase and test with Firebase's native example to make sure certs are correct
2. Try simple payload first, sometimes notification doesn't show up because of empty body, wrong sound name etc.

Libin Lu's avatar
Libin Lu committed
577
#### App running in background doesn't trigger `FCMNotificationReceived` when receiving hybrid notification [Android]
578
These is [an issue opened for that](https://github.com/google/gcm/issues/63). Behavior is not consistent between 2 platforms
579

Libin Lu's avatar
Libin Lu committed
580
#### Android notification is showing a white icon
581 582
Since Lollipop, the push notification icon is required to be all white, otherwise it will be a white circle.

Libin Lu's avatar
Libin Lu committed
583 584 585
#### iOS not receiving notification when the app running in the background
- Try adding Background Modes permission in Xcode->Click on project file->Capabilities tab->Background Modes->Remote Notifications

586 587 588 589 590 591 592
#### I am using Proguard
You need to add this to your `android/app/proguard-rules.pro`:
```
# Google Play Services
-keep class com.google.android.gms.** { *; }
-dontwarn com.google.android.gms.**
```
Libin Lu's avatar
init  
Libin Lu committed
593

Libin Lu's avatar
Libin Lu committed
594 595 596
#### I'm getting `com.android.dex.DexException: Multiple dex files define Lcom/google/android/gms/internal/zzqf;`
It is most likely that you are using other react-native-modules that requires conflicting google play service
search for `compile "com.google.android.gms` in android and see who specifies specific version. Resolve conflict by loosing their version or specify a version resolve in gradle.
Libin Lu's avatar
Libin Lu committed
597
Check this article https://medium.com/@suchydan/how-to-solve-google-play-services-version-collision-in-gradle-dependencies-ef086ae5c75f#.9l0u84y9t
Libin Lu's avatar
Libin Lu committed
598

Libin Lu's avatar
Libin Lu committed
599
#### How do I tell if user clicks the notification banner?
Naisheel Verdhan's avatar
Naisheel Verdhan committed
600
Check open from tray flag in notification. It will be either 0 or 1 for iOS and undefined or 1 for android. I decide for iOS based on [this](http://stackoverflow.com/questions/20569201/remote-notification-method-called-twice), and for android I set it if notification is triggered by intent change.
Libin Lu's avatar
Libin Lu committed
601

Libin Lu's avatar
Libin Lu committed
602
#### Android notification doesn't vibrate/show head-up display etc
603
All available features are [here](https://firebase.google.com/docs/cloud-messaging/http-server-ref#notification-payload-support). FCM may add more support in the future but there is no timeline.
Libin Lu's avatar
Libin Lu committed
604
In the mean time, you can pass "custom_notification" in a data message. This repo will show a local notification for you so you can set priority etc
Libin Lu's avatar
Libin Lu committed
605

Libin Lu's avatar
Libin Lu committed
606 607 608
#### How do I do xxx with FCM?
check out [official docs and see if they support](https://firebase.google.com/docs/cloud-messaging/concept-options)

Libin Lu's avatar
Libin Lu committed
609
#### I want to add advanced feature that FCM doesn't support for remote notification
Libin Lu's avatar
Libin Lu committed
610
You can either wait for FCM to develop it or you have to write native code to create notifications.
Libin Lu's avatar
Libin Lu committed
611 612
- for iOS, you can do it in `didReceiveRemoteNotification` in `appDelegate.m`
- for android, you can do it by implementing a service similar to "com.evollu.react.fcm.MessagingService"
Libin Lu's avatar
Libin Lu committed
613

Libin Lu's avatar
Libin Lu committed
614 615
Or if you have a good way to wake up react native javascript thread please let me know, although I'm worring waking up the whole application is too expensive.

Libin Lu's avatar
Libin Lu committed
616 617 618 619 620 621 622 623 624 625 626 627
#### What about new notifications in iOS 10
Congratulations, now you have 5 notification handler to register!
in sum
- `willPresentNotification` is introduced in iOS 10 and will only be called when local/remote notification will show up. This allows you to run some code **before** notification shows up. You can also decide how to show the notification.
- `didReceiveNotificationResponse` is introduced in iOS 10 and provides user's response together with local/remote notification. It could be swipe, text input etc.
- `didReceiveLocalNotification` is for iOS 9 and below. Triggered when user clicks local notification. replaced by `didReceiveNotificationResponse`
- `didReceiveRemoteNotification` is for iOS 9 and below. Triggered when remote notification received.
- `didReceiveRemoteNotification:fetchCompletionHandler` is for both iOS 9 and 10. it gets triggered 2 times for each remote notification. 1st time when notification is received. 2nd time when notification is clicked. in iOS 9, it serves us the purpose of both `willPresentNotification` and `didReceiveNotificationResponse` but for remote notification only. in iOS 10, you don't need it in most of the case unless you need to do background fetching

Great, how do I configure for FCM?
It is up to you! FCM is just a bridging library that passes notification into javascript world. You can define your own NSDictionary and pass it into notification.

Libin Lu's avatar
Libin Lu committed
628
#### I want to show notification when app is in foreground
Libin Lu's avatar
Libin Lu committed
629
Use `show_in_foreground` attribute to tell app to show banner even if the app is in foreground.
Libin Lu's avatar
Libin Lu committed
630
NOTE: this flag doesn't work for Android push notification, use `custom_notification` to achieve this.
Libin Lu's avatar
Libin Lu committed
631

Libin Lu's avatar
Libin Lu committed
632 633 634
#### Do I need to handle APNS token registration?
No. Method swizzling in Firebase Cloud Messaging handles this unless you turn that off. Then you are on your own to implement the handling. Check this link https://firebase.google.com/docs/cloud-messaging/ios/client

Libin Lu's avatar
Libin Lu committed
635 636 637
#### I want to add actions in iOS notification
Check this https://github.com/evollu/react-native-fcm/issues/325

Libin Lu's avatar
Libin Lu committed
638 639 640
#### React/RCTBridgeModule.h not found
This is mostly caused by React Native upgrade. Here is a fix http://stackoverflow.com/questions/41477241/react-native-xcode-upgrade-and-now-rctconvert-h-not-found

641 642
#### Some features are missing
Issues and pull requests are welcome. Let's make this thing better!
643

Libin Lu's avatar
Libin Lu committed
644
#### Credits
Libin Lu's avatar
Libin Lu committed
645
Local notification implementation is inspired by react-native-push-notification by zo0r