v1.1.1

Author: VladimirBrejcha

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.1.1
+- README.md improvements (thank you [VictorUvarov](https://github.com/voximplant/flutter_callkit/pull/5))
+- `FCXStartCallAction.contactIdentifier` and `FCXStartCallAction.video` parameters no longer ignored in native iOS code
+
 ## 1.1.0+3
 - LICENSE warning fix
 - Code formatted according to dartfmt
@@ -13,7 +17,7 @@
 - Handling push notifications example on Swift added
 
 ## 1.1.0
-'FlutterCallkitPlugin.hasCallWithUUID:' API added in iOS code
+`FlutterCallkitPlugin.hasCallWithUUID:` API added in iOS code
 
 ## 1.0.0
 Release

README.md

@@ -5,15 +5,18 @@ Flutter SDK for CallKit integration to Flutter applications on iOS
 Supported on iOS >= 10
 
 ## Install
+
 1. Add `flutter_callkit_voximplant` as a dependency in your pubspec.yaml file.
 
 2. Add the following entry to your `Info.plist` file, located in `<project root>/ios/Runner/Info.plist`:
-```
+
+```PLIST
 <key>UIBackgroundModes</key>
 <array>
-	<string>voip</string>
+  <string>voip</string>
 </array>
 ```
+
 This entry required for CallKit to work
 
 ## Usage
@@ -31,7 +34,8 @@ A few differences explained:
 - Use FCXPlugin.processPushCompletion (dart) to execute completion block received from push (iOS 11+ only)
 - FCXCallController and FCXProvider are only allowed in single instance (use it as a singletone)
 
-#### Initialization
+### Initialization
+
 ```dart
 import 'package:flutter_callkit_voximplant/flutter_callkit_voximplant.dart';
 
@@ -50,9 +54,11 @@ try {
 }
 ```
 
-#### Making outgoing calls
+### Making outgoing calls
+
 To make an outgoing call, an app requests a FCXStartCallAction object from its FCXCallController object.
 The action consists of a UUID to uniquely identify the call and a FCXHandle object to specify the recipient.
+
 ```dart
 Future<void> makeCall(String contactName, String uuid) async {
   FCXHandle handle = FCXHandle(FCXHandleType.Generic, contactName);
@@ -61,18 +67,17 @@ Future<void> makeCall(String contactName, String uuid) async {
 }
 ```
 
-After the recipient answers the call, the system calls the provider's performAnswerCallAction method.
-In your implementation of that method, configure an AVAudioSession and call the fulfill() method 
-on the action object when finished.
+After the call is connected, the system calls the provider's performStartCallAction method. In your implementation, 
+this method is responsible for configuring an AVAudioSession and calling fulfill() on the action when finished.
 
 ```dart
-_provider.performAnswerCallAction = (answerCallAction) async {
+_provider.performStartCallAction = (startCallAction) async {
   // configure audio session
-  await answerCallAction.fulfill();
+  await startCallAction.fulfill();
 };
 ```
 
-#### Receiving an Incoming Call
+### Receiving an Incoming Call
 
 Using the information provided by the external notification, 
 the app creates a UUID and a CXCallUpdate object to uniquely identify the call and the caller,
@@ -85,18 +90,18 @@ Future<void> handleIncomingCall(String contactName, String uuid) async {
 }
 ```
 
-After the call is connected, the system calls the performStartCallAction method of the provider.
-In your implementation, this method responsible for configuring an AVAudioSession
-and calling fulfill() on the action when finished.
+After the recipient answers the call, the system calls the performAnswerCallAction method of the provider.
+In your implementation of that method, configure an AVAudioSession and call the fulfill() method
+on the action object when finished.
 
 ```dart
-_provider.performStartCallAction = (startCallAction) async {
+_provider.performAnswerCallAction = (answerCallAction) async {
   // configure audio session
-  await startCallAction.fulfill();
+  await answerCallAction.fulfill();
 };
 ```
 
-#### Handling push notifications
+### Handling push notifications
 
 Note: This SDK is not related to PushKit
 
@@ -105,6 +110,7 @@ Push handling must be done through native iOS code due to [iOS 13 PushKit VoIP r
 Flutter CallKit SDK has built-in reportNewIncomingCallWithUUID:callUpdate:providerConfiguration:pushProcessingCompletion:) method (iOS) to correctly work with it
 
 #### Swift
+
 ```swift
 import Flutter
 import flutter_callkit_voximplant
@@ -119,15 +125,15 @@ class AppDelegate: FlutterAppDelegate, PKPushRegistryDelegate {
     ) {
         processPush(with: payload.dictionaryPayload, and: nil)
     }
-    
+
     func pushRegistry(_ registry: PKPushRegistry,
                       didReceiveIncomingPushWith payload: PKPushPayload,
                       for type: PKPushType,
                       completion: @escaping () -> Void
     ) {
         processPush(with: payload.dictionaryPayload, and: completion)
     }
-    
+
     // 2. process push
     private func processPush(with payload: Dictionary<AnyHashable, Any>,
                              and completion: (() -> Void)?
@@ -156,6 +162,7 @@ class AppDelegate: FlutterAppDelegate, PKPushRegistryDelegate {
 ```
 
 #### Objective-C
+
 ```objective-c
 #import <Flutter/Flutter.h>
 #import <FlutterCallkitPlugin.h>
@@ -169,23 +176,23 @@ class AppDelegate: FlutterAppDelegate, PKPushRegistryDelegate {
 @implementation AppDelegate
 
 // 1. override PKPushRegistryDelegate methods
-- (void)             pushRegistry:(PKPushRegistry *)registry 
-didReceiveIncomingPushWithPayload:(PKPushPayload *)payload 
+- (void)             pushRegistry:(PKPushRegistry *)registry
+didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
                           forType:(PKPushType)type {
     [self processPushWithPayload:payload.dictionaryPayload 
             andCompletionHandler:nil];
 }
 
-- (void)             pushRegistry:(PKPushRegistry *)registry 
+- (void)             pushRegistry:(PKPushRegistry *)registry
 didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
-                          forType:(PKPushType)type 
+                          forType:(PKPushType)type
             withCompletionHandler:(void (^)(void))completion {
     [self processPushWithPayload:payload.dictionaryPayload
             andCompletionHandler:completion];
 }
 
 // 2. process push
--(void)processPushWithPayload:(NSDictionary *)payload 
+-(void)processPushWithPayload:(NSDictionary *)payload
          andCompletionHandler:(dispatch_block_t)completion {
     // 3. get uuid and other needed information from payload
     NSUUID *UUID = [[NSUUID alloc] initWithUUIDString:payload[@"UUID"]];
@@ -194,8 +201,8 @@ didReceiveIncomingPushWithPayload:(PKPushPayload *)payload
     CXCallUpdate *callUpdate = [CXCallUpdate new];
     callUpdate.localizedCallerName = localizedName;
     // 5. prepare provider configuration
-    CXProviderConfiguration *configuration = 
-        [[CXProviderConfiguration alloc] 
+    CXProviderConfiguration *configuration =
+        [[CXProviderConfiguration alloc]
               initWithLocalizedName:@"ExampleLocalizedName"];
     // 6. send it to plugin
     [FlutterCallkitPlugin reportNewIncomingCallWithUUID:UUID

example/ios/Podfile.lock

@@ -1,6 +1,6 @@
 PODS:
   - Flutter (1.0.0)
-  - "flutter_callkit_voximplant (1.1.0+3)":
+  - flutter_callkit_voximplant (1.1.1):
     - Flutter
 
 DEPENDENCIES:
@@ -15,8 +15,8 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   Flutter: 0e3d915762c693b495b44d77113d4970485de6ec
-  flutter_callkit_voximplant: c37fe6b128546d215843c5442757c3e6051e9680
+  flutter_callkit_voximplant: b01193937c96e634258721bb38d520c201f69bfc
 
 PODFILE CHECKSUM: 8e679eca47255a8ca8067c4c67aab20e64cb974d
 
-COCOAPODS: 1.9.3
+COCOAPODS: 1.10.0

example/ios/Runner.xcodeproj/project.pbxproj

@@ -36,7 +36,7 @@
 		7AFA3C8E1D35360C0083082E /* Release.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Release.xcconfig; path = Flutter/Release.xcconfig; sourceTree = "<group>"; };
 		7AFFD8ED1D35381100E5BB4D /* AppDelegate.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = AppDelegate.h; sourceTree = "<group>"; };
 		7AFFD8EE1D35381100E5BB4D /* AppDelegate.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = AppDelegate.m; sourceTree = "<group>"; };
-		7E090D30253F69A800C5BA19 /* Profile.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Profile.xcconfig; path = Flutter/Profile.xcconfig; sourceTree = "<group>"; };
+		7E090D29253F679F00C5BA19 /* Profile.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; name = Profile.xcconfig; path = Flutter/Profile.xcconfig; sourceTree = "<group>"; };
 		9740EEB21CF90195004384FC /* Debug.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Debug.xcconfig; path = Flutter/Debug.xcconfig; sourceTree = "<group>"; };
 		9740EEB31CF90195004384FC /* Generated.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; name = Generated.xcconfig; path = Flutter/Generated.xcconfig; sourceTree = "<group>"; };
 		97C146EE1CF9000F007C117D /* Runner.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Runner.app; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -68,11 +68,11 @@
 		9740EEB11CF90186004384FC /* Flutter */ = {
 			isa = PBXGroup;
 			children = (
-				7E090D30253F69A800C5BA19 /* Profile.xcconfig */,
 				3B3967151E833CAA004F5970 /* AppFrameworkInfo.plist */,
 				9740EEB21CF90195004384FC /* Debug.xcconfig */,
 				7AFA3C8E1D35360C0083082E /* Release.xcconfig */,
 				9740EEB31CF90195004384FC /* Generated.xcconfig */,
+				7E090D29253F679F00C5BA19 /* Profile.xcconfig */,
 			);
 			name = Flutter;
 			sourceTree = "<group>";
@@ -148,7 +148,7 @@
 		97C146E61CF9000F007C117D /* Project object */ = {
 			isa = PBXProject;
 			attributes = {
-				LastUpgradeCheck = 1200;
+				LastUpgradeCheck = 1020;
 				ORGANIZATIONNAME = "The Chromium Authors";
 				TargetAttributes = {
 					97C146ED1CF9000F007C117D = {
@@ -276,7 +276,6 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
-				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
@@ -306,7 +305,7 @@
 		};
 		249021D4217E4FDB00AE95B9 /* Profile */ = {
 			isa = XCBuildConfiguration;
-			baseConfigurationReference = 7E090D30253F69A800C5BA19 /* Profile.xcconfig */;
+			baseConfigurationReference = 7E090D29253F679F00C5BA19 /* Profile.xcconfig */;
 			buildSettings = {
 				ASSETCATALOG_COMPILER_APPICON_NAME = AppIcon;
 				CURRENT_PROJECT_VERSION = "$(FLUTTER_BUILD_NUMBER)";
@@ -352,7 +351,6 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
-				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;
@@ -408,7 +406,6 @@
 				CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES;
 				CLANG_WARN_OBJC_LITERAL_CONVERSION = YES;
 				CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR;
-				CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = YES;
 				CLANG_WARN_RANGE_LOOP_ANALYSIS = YES;
 				CLANG_WARN_STRICT_PROTOTYPES = YES;
 				CLANG_WARN_SUSPICIOUS_MOVE = YES;

example/lib/call_service.dart

@@ -23,9 +23,7 @@ class CallService {
   CallChanged callChangedEvent;
   bool _configured = false;
 
-  String getCallerName() {
-    return _managedCall?.callerName;
-  }
+  String get callerName => _managedCall?.callerName;
 
   Future<void> emulateIncomingCall(String contactName) async {
     await _configure();
@@ -52,6 +50,8 @@ class CallService {
     FCXHandle handle = FCXHandle(FCXHandleType.Generic, contactName);
 
     FCXStartCallAction action = FCXStartCallAction(_managedCall.uuid, handle);
+    action.contactIdentifier = 'Example contact ID';
+    action.video = false;
 
     await _callController.requestTransactionWithAction(action);
   }
@@ -66,11 +66,12 @@ class CallService {
     await _callController.configure();
 
     FCXProviderConfiguration configuration = FCXProviderConfiguration(
-        'FlutterCallKit',
-        includesCallsInRecents: true,
-        supportsVideo: false,
-        maximumCallsPerCallGroup: 1,
-        supportedHandleTypes: {FCXHandleType.Generic});
+      'FlutterCallKit',
+      includesCallsInRecents: true,
+      supportsVideo: false,
+      maximumCallsPerCallGroup: 1,
+      supportedHandleTypes: {FCXHandleType.Generic},
+    );
 
     await _provider.configure(configuration);
 

example/lib/main.dart

@@ -3,8 +3,10 @@ import 'package:flutter_callkit_example/screens/main_screen.dart';
 
 void main() {
   WidgetsFlutterBinding.ensureInitialized();
-  runApp(MaterialApp(
-    title: 'FlutterCallKit',
-    home: MainScreen(),
-  ));
+  runApp(
+    MaterialApp(
+      title: 'FlutterCallKit',
+      home: MainScreen(),
+    ),
+  );
 }

example/lib/screens/call_screen.dart

@@ -41,20 +41,21 @@ class _CallScreenState extends State<CallScreen> {
       ),
       body: Center(
         child: Column(
-            mainAxisAlignment: MainAxisAlignment.center,
-            children: <Widget>[
-              SizedBox(
-                child: Text(
-                  '${_callService.getCallerName() ?? ''}',
-                  style: TextStyle(fontSize: 30),
-                ),
-                height: 100,
+          mainAxisAlignment: MainAxisAlignment.center,
+          children: <Widget>[
+            SizedBox(
+              child: Text(
+                '${_callService.callerName ?? ''}',
+                style: TextStyle(fontSize: 30),
               ),
-              ExampleButton('${_muted ? 'Unmute' : 'Mute'}', _muteOnTouch),
-              ExampleButton('${_onHold ? 'Resume' : 'Hold'}', _holdOnTouch),
-              ExampleButton('Send DTMF', _dtmfOnTouch),
-              ExampleButton('Hangup', _onHangupTouch)
-            ]),
+              height: 100,
+            ),
+            ExampleButton('${_muted ? 'Unmute' : 'Mute'}', _muteOnTouch),
+            ExampleButton('${_onHold ? 'Resume' : 'Hold'}', _holdOnTouch),
+            ExampleButton('Send DTMF', _dtmfOnTouch),
+            ExampleButton('Hangup', _onHangupTouch)
+          ],
+        ),
       ),
     );
   }