update doc

Author: Quoc Khanh

README.md

@@ -1,11 +1,31 @@
-# react-native-incoming-call
+# RN Incoming Call Version 2
 
 > React Native module to display custom incoming call activity, best result when using with firebase background messaging. Only for Android since iOS we have VoIP.
 
 Yes I heard you could use **self managed ConnectionService** thing. But since I'm not an Android expert, this is a solution I found acceptable.
 
 You could also wait for [this feature request](https://github.com/react-native-webrtc/react-native-callkeep/issues/43) from `react-native-callkeep` to be resolved and have an easier life.
 
+## Version 2 Breaking Changes
+
+Hello there! It's been a while since I first public version 1 of this library, which contains some bugs that I don't have much time to fix.
+
+Luckily I got a client project which needs this feature again and now I have time to improve it and make sure all major features work. So here is most of it I guess:
+
+[x] More generic incoming call UI.
+
+[x] Work nicely with all application state (foreground, background, killed, locked).
+
+[x] More flexible APIs.
+
+*Thanks to [jpudysz](https://github.com/jpudysz/react-native-callkeep)'s folk of react-native-callkeep, version 2 is heavily depended on it.*
+
+### Migrate from v1
+
+- `getLaunchParameters()` & `clearLaunchParameters()` is now replaced by `openAppFromHeadlessMode()` & `getExtrasFromHeadlessMode()`.
+
+- Answer calls from background / killed state no longer open app and send launchParams, you need to listen to `answerCall` event from headless job and trigger `backToForeground` or `openAppFromHeadlessMode` manually.
+
 ## Getting started
 
 `$ npm install react-native-incoming-call --save`
@@ -16,48 +36,103 @@ or
 
 ### Addition installation step
 
-In `AndroidManifest.xml`, add `<activity android:name="com.incomingcall.UnlockScreenActivity" />` line between `<application>` tag.
+In `AndroidManifest.xml`:
+
+- Add `<activity android:name="com.incomingcall.UnlockScreenActivity" />` line between `<application>` tag.
+
+- Add `<uses-permission android:name="android.permission.VIBRATE" />` permission.
+
+- Also, it's recommend to put `android:launchMode="singleInstance"` in `<activity android:name=".MainActivity"...` tag to prevent duplicate activities.
 
 For RN >= 0.60, it's done. Otherwise:
 
 `$ react-native link react-native-incoming-call`
 
 ## Usage
+
+In `App.js`:
+
 ```javascript
 import {useEffect} from 'react';
+import {DeviceEventEmitter, Platform} from 'react-native';
 import IncomingCall from 'react-native-incoming-call';
 
-// Display incoming call activity. Should be called in backgroundHandler function of react-native-firebase.
-IncomingCall.display(uuid, name, avatar);
-
-// Dismiss current activity. Should be called when call ended.
-IncomingCall.dismiss();
-
 // Listen to cancel and answer call events
 useEffect(() => {
   if (Platform.OS === "android") {
     /**
-     * App in background or killed state, if user press answer button
-     * IncomingCall open app and put payload to getLaunchParameters
-     * You could start the call action here.
-     * End call action in this case not supported yet.
+     * App open from killed state (headless mode)
     */
-    const payload = await IncomingCall.getLaunchParameters();
+    const payload = await IncomingCall.getExtrasFromHeadlessMode();
     console.log('launchParameters', payload);
-    IncomingCall.clearLaunchParameters();
     if (payload) {
-      // Start call here
+      // Start call action here. You probably want to navigate to some CallRoom screen with the payload.uuid.
     }
 
     /**
-     * App in foreground: listen to call events and determine what to do next
+     * App in foreground / background: listen to call events and determine what to do next
     */
     DeviceEventEmitter.addListener("endCall", payload => {
       // End call action here
     });
     DeviceEventEmitter.addListener("answerCall", payload => {
-      // Start call action here
+      // Start call action here. You probably want to navigate to some CallRoom screen with the payload.uuid.
     });
   }
 }, []);
 ```
+
+In `index.js` or anywhere firebase background handler lies: 
+
+```javascript
+import messaging from '@react-native-firebase/messaging';
+import {DeviceEventEmitter} from 'react-native';
+import IncomingCall from 'react-native-incoming-call';
+
+messaging().setBackgroundMessageHandler(async remoteMessage => {
+  // Receive remote message
+  if (remoteMessage?.notification?.title === 'Incoming Call') {
+    // Display incoming call activity.
+    IncomingCall.display(
+      'callUUIDv4', // Call UUID v4
+      'Quocs', // Username
+      'https://avatars3.githubusercontent.com/u/16166195', // Avatar URL
+      'Incomming Call' // Info text
+    );
+  } else if (remoteMessage?.notification?.title === 'Missed Call') {
+    // Terminate incoming activity. Should be called when call expired.
+    IncomingCall.dismiss();
+  }
+
+  // Listen to headless action events
+  DeviceEventEmitter.addListener("endCall", payload => {
+    // End call action here
+  });
+  DeviceEventEmitter.addListener("answerCall", (payload) => {
+    console.log('answerCall', payload);
+    if (payload.isHeadless) {
+      // Called from killed state
+      IncomingCall.openAppFromHeadlessMode(payload.uuid);
+    } else {
+      // Called from background state
+      IncomingCall.backToForeground();
+    }
+  });
+});
+```
+
+## Well-known issues
+
+### Incoming screen not show on android > 9:
+
+You need to turn on autostart and display pop-up windows permissions manually. I'm searching for a better solution.
+
+### No vibration when screen locked:
+
+PR is welcomed! 😂
+
+## License
+
+This project is licensed under the MIT License.
+
+[[email protected]](mailto:[email protected])

example/android/app/src/main/AndroidManifest.xml

@@ -30,6 +30,7 @@
         android:turnScreenOn="true"
         android:showWhenLocked="true"
         android:exported="true"
+        android:launchMode="singleInstance"
         android:windowSoftInputMode="adjustResize">
       </activity>
       <activity

example/yarn.lock

@@ -5443,7 +5443,7 @@ react-native-bootsplash@^2.2.4:
 
 "react-native-incoming-call@git+https://github.com/bkdev98/react-native-incoming-call.git#v2":
   version "2.0.0"
-  resolved "git+https://github.com/bkdev98/react-native-incoming-call.git#40348f0b266a19ea64d47d0d31e6859e19b37d18"
+  resolved "git+https://github.com/bkdev98/react-native-incoming-call.git#ea8fe8c4711fa39c316f34c5ed412de3f07a12f1"
 
 [email protected]:
   version "0.62.2"