Refactor reportNewIncomingCall and add some doc

Author: manuquentin

README.md

@@ -410,7 +410,7 @@ RNCallKeep.addEventListener('didActivateAudioSession', () => {
 Callback for `RNCallKeep.displayIncomingCall`
 
 ```js
-RNCallKeep.addEventListener('didDisplayIncomingCall', ({ error }) => {
+RNCallKeep.addEventListener('didDisplayIncomingCall', ({ error, uuid, handle, localizedCallerName, fromPushKit }) => {
   // you might want to do following things when receiving this event:
   // - Start playing ringback if it is an outgoing call
 });
@@ -567,7 +567,7 @@ class RNCallKeepExample extends React.Component {
   onDTMFAction = (data) => {
     let { digits, callUUID } = data;
     // Called when the system or user performs a DTMF action
-  }
+  };
 
   audioSessionActivated = (data) => {
     // you might want to do following things when receiving this event:
@@ -587,6 +587,33 @@ class RNCallKeepExample extends React.Component {
 }
 ```
 
+## Receiving a call when the application is not reachable.
+
+In some case your application can be unreachable :
+- when the user kill the application 
+- when it's in background since a long time (eg: after ~5mn the os will kill all connections).
+
+To be able to wake up your application to display the incoming call, you can use [https://github.com/ianlin/react-native-voip-push-notification](react-native-voip-push-notification) on iOS or BackgroundMessaging from [react-native-firebase](https://rnfirebase.io/docs/v5.x.x/messaging/receiving-messages#4)-(Optional)(Android-only)-Listen-for-FCM-messages-in-the-background).
+
+You have to send a push to your application, like with Firebase for Android and with a library supporting PushKit pushes for iOS.
+
+### PushKit
+
+Since iOS 13, you'll have to report the incoming calls that wakes up your application, like in your `AppDelegate.m` :
+
+```objective-c
+- (void)pushRegistry:(PKPushRegistry *)registry didReceiveIncomingPushWithPayload:(PKPushPayload *)payload forType:(PKPushType)type withCompletionHandler:(void (^)(void))completion {
+  // Process the received push
+  [RNVoipPushNotificationManager didReceiveIncomingPushWithPayload:payload forType:(NSString *)type];
+  
+  // Retrieve information like handle and callerName here
+  
+  [RNCallKeep reportNewIncomingCall:uuid handle:handle handleType:@"generic" hasVideo:false localizedCallerName:callerName fromPushKit: YES];
+
+  completion();
+}
+```
+
 ## Debug
 
 ### Android

ios/RNCallKeep/RNCallKeep.h

@@ -31,5 +31,6 @@ continueUserActivity:(NSUserActivity *)userActivity
                        handle:(NSString *)handle
                    handleType:(NSString *)handleType
                      hasVideo:(BOOL)hasVideo
-          localizedCallerName:(NSString * _Nullable)localizedCallerName;
+          localizedCallerName:(NSString * _Nullable)localizedCallerName
+                  fromPushKit:(BOOL)fromPushKit;
 @end

ios/RNCallKeep/RNCallKeep.m

@@ -72,17 +72,17 @@ - (void)dealloc
 - (NSArray<NSString *> *)supportedEvents
 {
     return @[
-             RNCallKeepDidReceiveStartCallAction,
-             RNCallKeepPerformAnswerCallAction,
-             RNCallKeepPerformEndCallAction,
-             RNCallKeepDidActivateAudioSession,
-             RNCallKeepDidDeactivateAudioSession,
-             RNCallKeepDidDisplayIncomingCall,
-             RNCallKeepDidPerformSetMutedCallAction,
-             RNCallKeepPerformPlayDTMFCallAction,
-             RNCallKeepDidToggleHoldAction,
-             RNCallKeepProviderReset
-             ];
+        RNCallKeepDidReceiveStartCallAction,
+        RNCallKeepPerformAnswerCallAction,
+        RNCallKeepPerformEndCallAction,
+        RNCallKeepDidActivateAudioSession,
+        RNCallKeepDidDeactivateAudioSession,
+        RNCallKeepDidDisplayIncomingCall,
+        RNCallKeepDidPerformSetMutedCallAction,
+        RNCallKeepPerformPlayDTMFCallAction,
+        RNCallKeepDidToggleHoldAction,
+        RNCallKeepProviderReset
+    ];
 }
 
 + (void)initCallKitProvider {
@@ -105,7 +105,7 @@ + (void)initCallKitProvider {
     [[NSUserDefaults standardUserDefaults] synchronize];
 
     [RNCallKeep initCallKitProvider];
-    
+
     self.callKeepProvider = sharedProvider;
     [self.callKeepProvider setDelegate:self queue:nil];
 }
@@ -140,29 +140,7 @@ + (void)initCallKitProvider {
                              hasVideo:(BOOL)hasVideo
                   localizedCallerName:(NSString * _Nullable)localizedCallerName)
 {
-#ifdef DEBUG
-    NSLog(@"[RNCallKeep][displayIncomingCall] uuidString = %@", uuidString);
-#endif
-    int _handleType = [RNCallKeep getHandleType:handleType];
-    NSUUID *uuid = [[NSUUID alloc] initWithUUIDString:uuidString];
-    CXCallUpdate *callUpdate = [[CXCallUpdate alloc] init];
-    callUpdate.remoteHandle = [[CXHandle alloc] initWithType:_handleType value:handle];
-    callUpdate.supportsDTMF = YES;
-    callUpdate.supportsHolding = YES;
-    callUpdate.supportsGrouping = YES;
-    callUpdate.supportsUngrouping = YES;
-    callUpdate.hasVideo = hasVideo;
-    callUpdate.localizedCallerName = localizedCallerName;
-
-    [self.callKeepProvider reportNewIncomingCallWithUUID:uuid update:callUpdate completion:^(NSError * _Nullable error) {
-        [self sendEventWithName:RNCallKeepDidDisplayIncomingCall body:@{ @"error": error ? error.localizedDescription : @"" }];
-        if (error == nil) {
-            // Workaround per https://forums.developer.apple.com/message/169511
-            if ([self lessThanIos10_2]) {
-                [self configureAudioSession];
-            }
-        }
-    }];
+    [RNCallKeep reportNewIncomingCall: uuidString handle:handle handleType:handleType hasVideo:hasVideo localizedCallerName:localizedCallerName fromPushKit: NO];
 }
 
 RCT_EXPORT_METHOD(startCall:(NSString *)uuidString
@@ -336,6 +314,7 @@ + (void)reportNewIncomingCall:(NSString *)uuidString
                    handleType:(NSString *)handleType
                      hasVideo:(BOOL)hasVideo
           localizedCallerName:(NSString * _Nullable)localizedCallerName
+                  fromPushKit:(BOOL)fromPushKit
 {
 #ifdef DEBUG
     NSLog(@"[RNCallKeep][reportNewIncomingCall] uuidString = %@", uuidString);
@@ -353,7 +332,14 @@ + (void)reportNewIncomingCall:(NSString *)uuidString
 
     [RNCallKeep initCallKitProvider];
     [sharedProvider reportNewIncomingCallWithUUID:uuid update:callUpdate completion:^(NSError * _Nullable error) {
-        if (error == nil) {}
+        RNCallKeep *callKeep = [RNCallKeep allocWithZone: nil];
+        [callKeep sendEventWithName:RNCallKeepDidDisplayIncomingCall body:@{ @"error": error ? error.localizedDescription : @"", @"callUUID": uuidString, @"handle": handle, @"localizedCallerName": localizedCallerName, @"fromPushKit": fromPushKit }];
+        if (error == nil) {
+            // Workaround per https://forums.developer.apple.com/message/169511
+            if ([callKeep lessThanIos10_2]) {
+                [callKeep configureAudioSession];
+            }
+        }
     }];
 }
 
@@ -481,9 +467,9 @@ + (BOOL)application:(UIApplication *)application
 
     if (handle != nil && handle.length > 0 ){
         NSDictionary *userInfo = @{
-                                   @"handle": handle,
-                                   @"video": @(isVideoCall)
-                                   };
+            @"handle": handle,
+            @"video": @(isVideoCall)
+        };
 
         [[NSNotificationCenter defaultCenter] postNotificationName:RNCallKeepHandleStartCallNotification
                                                             object:self
@@ -615,10 +601,10 @@ - (void)provider:(CXProvider *)provider didActivateAudioSession:(AVAudioSession
     NSLog(@"[RNCallKeep][CXProviderDelegate][provider:didActivateAudioSession]");
 #endif
     NSDictionary *userInfo
-        = @{
-            AVAudioSessionInterruptionTypeKey: [NSNumber numberWithInt:AVAudioSessionInterruptionTypeEnded],
-            AVAudioSessionInterruptionOptionKey: [NSNumber numberWithInt:AVAudioSessionInterruptionOptionShouldResume]
-            };
+    = @{
+        AVAudioSessionInterruptionTypeKey: [NSNumber numberWithInt:AVAudioSessionInterruptionTypeEnded],
+        AVAudioSessionInterruptionOptionKey: [NSNumber numberWithInt:AVAudioSessionInterruptionOptionShouldResume]
+    };
     [[NSNotificationCenter defaultCenter] postNotificationName:AVAudioSessionInterruptionNotification object:nil userInfo:userInfo];
 
     [self configureAudioSession];