README.md 3.69 KB
Newer Older
Libin Lu's avatar
init  
Libin Lu committed
1 2 3 4 5 6 7 8 9 10
## Installation

- Run `npm install react-native-fcm --save`
- Run rnpm link

## Android Configuration

- In `android/build.gradle`
```gradle
dependencies {
Libin Lu's avatar
Libin Lu committed
11 12
classpath 'com.android.tools.build:gradle:2.0.0'
classpath 'com.google.gms:google-services:3.0.0' // <- Add this line
Libin Lu's avatar
init  
Libin Lu committed
13 14 15 16 17 18 19 20 21
```

- In `android/app/build.gradle`
```gradle
apply plugin: "com.android.application"
apply plugin: 'com.google.gms.google-services' // <- Add this line
...
```

Libin Lu's avatar
Libin Lu committed
22
- In `android/app/src/main/AndroidManifest.xml`
Libin Lu's avatar
init  
Libin Lu committed
23 24 25

```
<application
Libin Lu's avatar
Libin Lu committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
android:theme="@style/AppTheme">

...
<service android:name="com.evollu.react.fcm.MessagingService">
<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
41 42 43 44 45 46 47 48
```

### IOS Configuration

install pod 'Firebase/Messaging'

in AppDelegate.m add
```
Libin Lu's avatar
Libin Lu committed
49
#import "RNFIRMessaging.h"
Libin Lu's avatar
Libin Lu committed
50
...
Libin Lu's avatar
init  
Libin Lu committed
51

Libin Lu's avatar
Libin Lu committed
52 53 54 55 56
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
....
[FIRApp configure]; <-- add this line
}
Libin Lu's avatar
init  
Libin Lu committed
57

Libin Lu's avatar
Libin Lu committed
58
//add this
Libin Lu's avatar
init  
Libin Lu committed
59
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)notification {
Libin Lu's avatar
Libin Lu committed
60 61 62
[[NSNotificationCenter defaultCenter] postNotificationName: FCMNotificationReceived
object:self
userInfo:notification];
Libin Lu's avatar
init  
Libin Lu committed
63 64 65

}

Libin Lu's avatar
Libin Lu committed
66
//add this
Libin Lu's avatar
init  
Libin Lu committed
67
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)notification fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))handler {
Libin Lu's avatar
Libin Lu committed
68 69 70 71
[[NSNotificationCenter defaultCenter] postNotificationName:FCMNotificationReceived
object:self
userInfo:notification];
handler(UIBackgroundFetchResultNoData);
Libin Lu's avatar
init  
Libin Lu committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85
}
```


### FCM config file
In [firebase console](https://console.firebase.google.com/), you can get `google-services.json` file and place it in `android/app` directory and get `googleServices-info.plist` file and place it in `/ios` directory

### Usage

```javascript

var FCM = require('react-native-fcm');

componentWillMount() {
Libin Lu's avatar
Libin Lu committed
86 87 88 89 90 91 92 93 94 95
FCM.requestPermissions();
FCM.getFCMToken().then(token => {
//store fcm token in your server
});
this.fcmNotifLsnr = DeviceEventEmitter.addListener('FCMNotificationReceived', (notif) => {
//there are two parts of notif. notif.notification contains the notification payload, notif.data contains data payload
});
this.fcmTokenLsnr = DeviceEventEmitter.addListener('FCMTokenRefreshed', (token) => {
//fcm token may not be available on first load, catch it here
});
Libin Lu's avatar
init  
Libin Lu committed
96 97 98
}

componentWillUnmount() {
Libin Lu's avatar
Libin Lu committed
99 100 101
//prevent leak
this.fcmNotifLsnr.remove();
this.fcmTokenLsnr.remove();
Libin Lu's avatar
init  
Libin Lu committed
102 103 104 105 106 107
}

}
```

## Q & A
Libin Lu's avatar
Libin Lu committed
108 109 110
### My android build is failing
Try update your SDK and google play service
### I can't get data notification when app is killed?
Libin Lu's avatar
init  
Libin Lu committed
111
If you send notification with payload only, you can only get the data message when app is in foreground or background. Killed app can't show notification
Libin Lu's avatar
Libin Lu committed
112
### I can't get data notification when app is in background with hybrid notification
Libin Lu's avatar
init  
Libin Lu committed
113
I want to figure it out too. Looks like that is how GCM/FCM works. I'm sending 2 notification separately for now. Let me know if you find a better solution
Libin Lu's avatar
Libin Lu committed
114
### I can't get notification payload when my android app is in foreground
Libin Lu's avatar
Libin Lu committed
115
It is better to use data payload if you need to pass data into application. I haven't implemented notification payload bridging in android module and am not planning to (the SDK should handle the payload for you)
Libin Lu's avatar
Libin Lu committed
116 117
### Notification payload and data payload are mixed in iOS app.
I'm not doing any filtering. Try to add some `type` attributes to differentiate data payload from APN notification
Libin Lu's avatar
Libin Lu committed
118 119
### It is missing some features
Issues and pull requests are welcomed. Let's make this thing better!
Libin Lu's avatar
init  
Libin Lu committed
120