Merge pull request #86 from r0b0t3d/ios-13

[ios-13] add new class method to report incoming call when receiving voip push

Author: manuquentin

README.md

@@ -423,7 +423,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
 });
@@ -580,7 +580,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:
@@ -600,6 +600,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

@@ -27,4 +27,10 @@
 continueUserActivity:(NSUserActivity *)userActivity
   restorationHandler:(void(^)(NSArray * __nullable restorableObjects))restorationHandler;
 
++ (void)reportNewIncomingCall:(NSString *)uuidString
+                       handle:(NSString *)handle
+                   handleType:(NSString *)handleType
+                     hasVideo:(BOOL)hasVideo
+          localizedCallerName:(NSString * _Nullable)localizedCallerName
+                  fromPushKit:(BOOL)fromPushKit;
 @end

ios/RNCallKeep/RNCallKeep.m

@@ -35,11 +35,12 @@
 
 @implementation RNCallKeep
 {
-    NSMutableDictionary *_settings;
     NSOperatingSystemVersion _version;
     BOOL _isStartCallActionEventListenerAdded;
 }
 
+static CXProvider* sharedProvider;
+
 // should initialise in AppDelegate.m
 RCT_EXPORT_MODULE()
 
@@ -73,23 +74,31 @@ - (void)dealloc
     if (self.callKeepProvider != nil) {
         [self.callKeepProvider invalidate];
     }
+    sharedProvider = nil;
 }
 
 // Override method of RCTEventEmitter
 - (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 {
+    if (sharedProvider == nil) {
+        NSDictionary *settings = [[NSUserDefaults standardUserDefaults] dictionaryForKey:@"RNCallKeepSettings"];
+        sharedProvider = [[CXProvider alloc] initWithConfiguration:[RNCallKeep getProviderConfiguration:settings]];
+    }
 }
 
 RCT_EXPORT_METHOD(setup:(NSDictionary *)options)
@@ -99,8 +108,14 @@ - (void)dealloc
 #endif
     _version = [[[NSProcessInfo alloc] init] operatingSystemVersion];
     self.callKeepCallController = [[CXCallController alloc] init];
-    _settings = [[NSMutableDictionary alloc] initWithDictionary:options];
-    self.callKeepProvider = [[CXProvider alloc] initWithConfiguration:[self getProviderConfiguration]];
+    NSDictionary *settings = [[NSMutableDictionary alloc] initWithDictionary:options];
+    // Store settings in NSUserDefault
+    [[NSUserDefaults standardUserDefaults] setObject:settings forKey:@"RNCallKeepSettings"];
+    [[NSUserDefaults standardUserDefaults] synchronize];
+
+    [RNCallKeep initCallKitProvider];
+
+    self.callKeepProvider = sharedProvider;
     [self.callKeepProvider setDelegate:self queue:nil];
 }
 
@@ -134,29 +149,7 @@ - (void)dealloc
                              hasVideo:(BOOL)hasVideo
                   localizedCallerName:(NSString * _Nullable)localizedCallerName)
 {
-#ifdef DEBUG
-    NSLog(@"[RNCallKeep][displayIncomingCall] uuidString = %@", uuidString);
-#endif
-    int _handleType = [self 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
@@ -168,7 +161,7 @@ - (void)dealloc
 #ifdef DEBUG
     NSLog(@"[RNCallKeep][startCall] uuidString = %@", uuidString);
 #endif
-    int _handleType = [self getHandleType:handleType];
+    int _handleType = [RNCallKeep getHandleType:handleType];
     NSUUID *uuid = [[NSUUID alloc] initWithUUIDString:uuidString];
     CXHandle *callHandle = [[CXHandle alloc] initWithType:_handleType value:handle];
     CXStartCallAction *startCallAction = [[CXStartCallAction alloc] initWithCallUUID:uuid handle:callHandle];
@@ -325,6 +318,40 @@ - (void)requestTransaction:(CXTransaction *)transaction
     }];
 }
 
++ (void)reportNewIncomingCall:(NSString *)uuidString
+                       handle:(NSString *)handle
+                   handleType:(NSString *)handleType
+                     hasVideo:(BOOL)hasVideo
+          localizedCallerName:(NSString * _Nullable)localizedCallerName
+                  fromPushKit:(BOOL)fromPushKit
+{
+#ifdef DEBUG
+    NSLog(@"[RNCallKeep][reportNewIncomingCall] 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;
+
+    [RNCallKeep initCallKitProvider];
+    [sharedProvider reportNewIncomingCallWithUUID:uuid update:callUpdate completion:^(NSError * _Nullable error) {
+        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];
+            }
+        }
+    }];
+}
+
 - (BOOL)lessThanIos10_2
 {
     if (_version.majorVersion < 10) {
@@ -336,7 +363,7 @@ - (BOOL)lessThanIos10_2
     }
 }
 
-- (int)getHandleType:(NSString *)handleType
++ (int)getHandleType:(NSString *)handleType
 {
     int _handleType;
     if ([handleType isEqualToString:@"generic"]) {
@@ -351,30 +378,30 @@ - (int)getHandleType:(NSString *)handleType
     return _handleType;
 }
 
-- (CXProviderConfiguration *)getProviderConfiguration
++ (CXProviderConfiguration *)getProviderConfiguration:(NSDictionary*)settings
 {
 #ifdef DEBUG
     NSLog(@"[RNCallKeep][getProviderConfiguration]");
 #endif
-    CXProviderConfiguration *providerConfiguration = [[CXProviderConfiguration alloc] initWithLocalizedName:_settings[@"appName"]];
+    CXProviderConfiguration *providerConfiguration = [[CXProviderConfiguration alloc] initWithLocalizedName:settings[@"appName"]];
     providerConfiguration.supportsVideo = YES;
     providerConfiguration.maximumCallGroups = 3;
     providerConfiguration.maximumCallsPerCallGroup = 1;
     providerConfiguration.supportedHandleTypes = [NSSet setWithObjects:[NSNumber numberWithInteger:CXHandleTypePhoneNumber], nil];
-    if (_settings[@"supportsVideo"]) {
-        providerConfiguration.supportsVideo = _settings[@"supportsVideo"];
+    if (settings[@"supportsVideo"]) {
+        providerConfiguration.supportsVideo = settings[@"supportsVideo"];
     }
-    if (_settings[@"maximumCallGroups"]) {
-        providerConfiguration.maximumCallGroups = [_settings[@"maximumCallGroups"] integerValue];
+    if (settings[@"maximumCallGroups"]) {
+        providerConfiguration.maximumCallGroups = [settings[@"maximumCallGroups"] integerValue];
     }
-    if (_settings[@"maximumCallsPerCallGroup"]) {
-        providerConfiguration.maximumCallsPerCallGroup = [_settings[@"maximumCallsPerCallGroup"] integerValue];
+    if (settings[@"maximumCallsPerCallGroup"]) {
+        providerConfiguration.maximumCallsPerCallGroup = [settings[@"maximumCallsPerCallGroup"] integerValue];
     }
-    if (_settings[@"imageName"]) {
-        providerConfiguration.iconTemplateImageData = UIImagePNGRepresentation([UIImage imageNamed:_settings[@"imageName"]]);
+    if (settings[@"imageName"]) {
+        providerConfiguration.iconTemplateImageData = UIImagePNGRepresentation([UIImage imageNamed:settings[@"imageName"]]);
     }
-    if (_settings[@"ringtoneSound"]) {
-        providerConfiguration.ringtoneSound = _settings[@"ringtoneSound"];
+    if (settings[@"ringtoneSound"]) {
+        providerConfiguration.ringtoneSound = settings[@"ringtoneSound"];
     }
     return providerConfiguration;
 }
@@ -449,9 +476,9 @@ + (BOOL)application:(UIApplication *)application
 
     if (handle != nil && handle.length > 0 ){
         NSDictionary *userInfo = @{
-                                   @"handle": handle,
-                                   @"video": @(isVideoCall)
-                                   };
+            @"handle": handle,
+            @"video": @(isVideoCall)
+        };
 
         RNCallKeep *callKeep = [RNCallKeep allocWithZone: nil];
         [callKeep handleStartCallNotification: userInfo];
@@ -583,10 +610,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];