Merge pull request #15 from ConnectyCube/feature/extend_functionality

- release 0.1.0-dev1;

Author: TatankaConCube

CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.1.0-dev.1
+
+* New:
+    - Implemented Dart [null-safety](https://dart.dev/null-safety) feature;
+    - Added method `getCallData(String? sessionId)` for getting all provided data about the call;
+    - Added method `clearCallData(String? sessionId)` which cleans all data related to the call;
+    - Added method `getLastCallId()` which returns the id of the last displayed call. It is useful on starting app step for navigation to the call screen if the call was accepted;
+    - Added static callback `onCallAcceptedWhenTerminated` which can be useful if need listen to events from the Call notification in the background or terminated state;
+
+* Improvements:
+    - Added new field `userInfo`, which can be used for exchanging with additional data between the Call notification and your app, you will get this data in callbacks `onCallAcceptedWhenTerminated`, `onCallAccepted`, `onCallRejectedWhenTerminated`, `onCallRejected` after setting it in method `showCallNotification`;
+
+* Fixes:
+    - Fixed the wrong calback naming `onCallAcceptedWhenTerminated` -> `onCallRejectedWhenTerminated`;
+
 ## 0.0.1-dev.1
 
 * Initial release.

android/src/main/AndroidManifest.xml

@@ -8,7 +8,10 @@
             android:excludeFromRecents="true"
             android:noHistory="true"
             android:screenOrientation="sensorPortrait"
+            android:showOnLockScreen="true"
+            android:showWhenLocked="true"
             android:taskAffinity="com.connectycube.flutter.connectycube_flutter_call_kit.INCOMING_CALL_AFFINITY"
-            android:theme="@android:style/Theme.Holo.NoActionBar" />
+            android:theme="@android:style/Theme.Holo.NoActionBar"
+            android:turnScreenOn="true" />
     </application>
 </manifest>

android/src/main/kotlin/com/connectycube/flutter/connectycube_flutter_call_kit/ConnectycubeFlutterCallKitPlugin.kt

@@ -12,8 +12,7 @@ import android.view.WindowManager
 import androidx.annotation.Keep
 import androidx.annotation.NonNull
 import androidx.localbroadcastmanager.content.LocalBroadcastManager
-import com.connectycube.flutter.connectycube_flutter_call_kit.utils.getString
-import com.connectycube.flutter.connectycube_flutter_call_kit.utils.putString
+import com.connectycube.flutter.connectycube_flutter_call_kit.utils.*
 import io.flutter.embedding.engine.plugins.FlutterPlugin
 import io.flutter.embedding.engine.plugins.activity.ActivityAware
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding
@@ -27,14 +26,18 @@ import io.flutter.plugin.common.PluginRegistry
 
 /** ConnectycubeFlutterCallKitPlugin */
 @Keep
-class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, PluginRegistry.NewIntentListener, ActivityAware, BroadcastReceiver() {
+class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler,
+    PluginRegistry.NewIntentListener, ActivityAware, BroadcastReceiver() {
     private var applicationContext: Context? = null
     private var mainActivity: Activity? = null
     private lateinit var channel: MethodChannel
     private lateinit var localBroadcastManager: LocalBroadcastManager
 
     override fun onAttachedToEngine(@NonNull flutterPluginBinding: FlutterPlugin.FlutterPluginBinding) {
-        onAttachedToEngine(flutterPluginBinding.applicationContext, flutterPluginBinding.binaryMessenger)
+        onAttachedToEngine(
+            flutterPluginBinding.applicationContext,
+            flutterPluginBinding.binaryMessenger
+        )
         registerCallStateReceiver()
     }
 
@@ -48,7 +51,8 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
         when (call.method) {
             "showCallNotification" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val callId = arguments["session_id"] as String
 
                     if (CALL_STATE_UNKNOWN != getCallState(callId)) {
@@ -60,11 +64,23 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
                     val callInitiatorId = arguments["caller_id"] as Int
                     val callInitiatorName = arguments["caller_name"] as String
                     val callOpponents = ArrayList((arguments["call_opponents"] as String)
-                            .split(',')
-                            .map { it.toInt() })
-                    showCallNotification(applicationContext!!, callId, callType, callInitiatorId, callInitiatorName, callOpponents)
+                        .split(',')
+                        .map { it.toInt() })
+                    val userInfo = arguments["user_info"] as String
+
+                    showCallNotification(
+                        applicationContext!!,
+                        callId,
+                        callType,
+                        callInitiatorId,
+                        callInitiatorName,
+                        callOpponents,
+                        userInfo
+                    )
 
                     saveCallState(callId, CALL_STATE_PENDING)
+                    saveCallData(callId, arguments)
+                    saveCallId(callId)
 
                     result.success(null)
                 } catch (e: Exception) {
@@ -74,7 +90,8 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
 
             "reportCallAccepted" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val callId = arguments["session_id"] as String
                     cancelCallNotification(applicationContext!!, callId)
 
@@ -88,7 +105,8 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
 
             "reportCallEnded" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val callId = arguments["session_id"] as String
 
                     processCallEnded(callId)
@@ -102,7 +120,8 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
 
             "getCallState" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val callId = arguments["session_id"] as String
 
                     result.success(getCallState(callId))
@@ -113,7 +132,8 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
 
             "setCallState" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val callId = arguments["session_id"] as String
                     val callState = arguments["call_state"] as String
 
@@ -125,9 +145,22 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
                 }
             }
 
+            "getCallData" -> {
+                try {
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
+                    val callId = arguments["session_id"] as String
+
+                    result.success(getCallData(callId))
+                } catch (e: Exception) {
+                    result.error("ERROR", e.message, "")
+                }
+            }
+
             "setOnLockScreenVisibility" -> {
                 try {
-                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> = call.arguments as Map<String, Any>
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
                     val isVisible = arguments["is_visible"] as Boolean
 
                     setOnLockScreenVisibility(isVisible)
@@ -137,6 +170,27 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
                 }
             }
 
+            "clearCallData" -> {
+                try {
+                    @Suppress("UNCHECKED_CAST") val arguments: Map<String, Any> =
+                        call.arguments as Map<String, Any>
+                    val callId = arguments["session_id"] as String
+
+                    clearCallData(callId)
+                    result.success(null)
+                } catch (e: Exception) {
+                    result.error("ERROR", e.message, "")
+                }
+            }
+
+            "getLastCallId" -> {
+                try {
+                    result.success(getLastCallId())
+                } catch (e: Exception) {
+                    result.error("ERROR", e.message, "")
+                }
+            }
+
             else ->
                 result.notImplemented()
 
@@ -196,7 +250,9 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
         parameters["call_type"] = intent.getIntExtra(EXTRA_CALL_TYPE, -1)
         parameters["caller_id"] = intent.getIntExtra(EXTRA_CALL_INITIATOR_ID, -1)
         parameters["caller_name"] = intent.getStringExtra(EXTRA_CALL_INITIATOR_NAME)
-        parameters["call_opponents"] = intent.getIntegerArrayListExtra(EXTRA_CALL_OPPONENTS)?.joinToString(separator = ",")
+        parameters["call_opponents"] =
+            intent.getIntegerArrayListExtra(EXTRA_CALL_OPPONENTS)?.joinToString(separator = ",")
+        parameters["user_info"] = intent.getStringExtra(EXTRA_CALL_USER_INFO)
 
         when (action) {
             ACTION_CALL_REJECT -> {
@@ -242,19 +298,66 @@ class ConnectycubeFlutterCallKitPlugin : FlutterPlugin, MethodCallHandler, Plugi
     private fun saveCallState(callId: String, callState: String) {
         if (applicationContext == null) return
 
-        putString(applicationContext!!, callId, callState)
+        putString(applicationContext!!, callId + "_state", callState)
     }
 
     private fun getCallState(callId: String): String {
         if (applicationContext == null) return CALL_STATE_UNKNOWN
 
-        val callState: String? = getString(applicationContext!!, callId)
+        val callState: String? = getString(applicationContext!!, callId + "_state")
 
         if (TextUtils.isEmpty(callState)) return CALL_STATE_UNKNOWN
 
         return callState!!
     }
 
+    private fun getCallData(callId: String): Map<String, *>? {
+        if (applicationContext == null) return null
+
+        val callDataString: String? = getString(applicationContext!!, callId + "_data")
+
+        if (TextUtils.isEmpty(callDataString)) return null
+
+        return getMapFromJsonString(callDataString!!)
+    }
+
+    private fun saveCallData(callId: String, callData: Map<String, *>) {
+        if (applicationContext == null) return
+
+        try {
+            putString(applicationContext!!, callId + "_data", mapToJsonString(callData))
+        } catch (e: Exception) {
+            // ignore
+        }
+    }
+
+    private fun clearCallData(callId: String) {
+        if (applicationContext == null) return
+
+        try {
+            remove(applicationContext!!, callId + "_state")
+            remove(applicationContext!!, callId + "_data")
+        } catch (e: Exception) {
+            // ignore
+        }
+    }
+
+    private fun saveCallId(callId: String) {
+        if (applicationContext == null) return
+
+        try {
+            putString(applicationContext!!, "last_call_id", callId)
+        } catch (e: Exception) {
+            // ignore
+        }
+    }
+
+    private fun getLastCallId(): String? {
+        if (applicationContext == null) return null
+
+        return getString(applicationContext!!, "last_call_id")
+    }
+
     private fun processCallEnded(sessionId: String) {
         if (applicationContext == null) return
 

android/src/main/kotlin/com/connectycube/flutter/connectycube_flutter_call_kit/Constants.kt

@@ -5,6 +5,7 @@ const val EXTRA_CALL_TYPE = "extra_call_type"
 const val EXTRA_CALL_INITIATOR_ID = "extra_call_initiator_id"
 const val EXTRA_CALL_INITIATOR_NAME = "extra_call_initiator_name"
 const val EXTRA_CALL_OPPONENTS = "extra_call_opponents"
+const val EXTRA_CALL_USER_INFO = "extra_call_user_info"
 
 const val ACTION_CALL_ACCEPT = "action_call_accept"
 const val ACTION_CALL_REJECT = "action_call_reject"

android/src/main/kotlin/com/connectycube/flutter/connectycube_flutter_call_kit/EventReceiver.kt

@@ -24,6 +24,7 @@ class EventReceiver : BroadcastReceiver() {
                 val callInitiatorId = extras?.getInt(EXTRA_CALL_INITIATOR_ID)
                 val callInitiatorName = extras?.getString(EXTRA_CALL_INITIATOR_NAME)
                 val callOpponents = extras?.getIntegerArrayList(EXTRA_CALL_OPPONENTS)
+                val userInfo = extras?.getString(EXTRA_CALL_USER_INFO)
                 Log.i(TAG, "NotificationReceiver onReceive Call REJECT, callId: $callId")
 
                 val broadcastIntent = Intent(ACTION_CALL_REJECT)
@@ -33,10 +34,11 @@ class EventReceiver : BroadcastReceiver() {
                 bundle.putInt(EXTRA_CALL_INITIATOR_ID, callInitiatorId!!)
                 bundle.putString(EXTRA_CALL_INITIATOR_NAME, callInitiatorName)
                 bundle.putIntegerArrayList(EXTRA_CALL_OPPONENTS, callOpponents)
+                bundle.putString(EXTRA_CALL_USER_INFO, userInfo)
                 broadcastIntent.putExtras(bundle)
 
                 LocalBroadcastManager.getInstance(context.applicationContext)
-                        .sendBroadcast(broadcastIntent)
+                    .sendBroadcast(broadcastIntent)
 
                 NotificationManagerCompat.from(context).cancel(callId.hashCode())
             }
@@ -48,6 +50,7 @@ class EventReceiver : BroadcastReceiver() {
                 val callInitiatorId = extras?.getInt(EXTRA_CALL_INITIATOR_ID)
                 val callInitiatorName = extras?.getString(EXTRA_CALL_INITIATOR_NAME)
                 val callOpponents = extras?.getIntegerArrayList(EXTRA_CALL_OPPONENTS)
+                val userInfo = extras?.getString(EXTRA_CALL_USER_INFO)
                 Log.i(TAG, "NotificationReceiver onReceive Call ACCEPT, callId: $callId")
 
                 val broadcastIntent = Intent(ACTION_CALL_ACCEPT)
@@ -57,10 +60,11 @@ class EventReceiver : BroadcastReceiver() {
                 bundle.putInt(EXTRA_CALL_INITIATOR_ID, callInitiatorId!!)
                 bundle.putString(EXTRA_CALL_INITIATOR_NAME, callInitiatorName)
                 bundle.putIntegerArrayList(EXTRA_CALL_OPPONENTS, callOpponents)
+                bundle.putString(EXTRA_CALL_USER_INFO, userInfo)
                 broadcastIntent.putExtras(bundle)
 
                 LocalBroadcastManager.getInstance(context.applicationContext)
-                        .sendBroadcast(broadcastIntent)
+                    .sendBroadcast(broadcastIntent)
 
                 NotificationManagerCompat.from(context).cancel(callId.hashCode())
             }
@@ -71,9 +75,18 @@ class EventReceiver : BroadcastReceiver() {
                 val callType = extras?.getInt(EXTRA_CALL_TYPE)
                 val callInitiatorId = extras?.getInt(EXTRA_CALL_INITIATOR_ID)
                 val callInitiatorName = extras?.getString(EXTRA_CALL_INITIATOR_NAME)
-                Log.i(TAG, "NotificationReceiver onReceive Delete Call Notification, callId: $callId")
+                val userInfo = extras?.getString(EXTRA_CALL_USER_INFO)
+                Log.i(
+                    TAG,
+                    "NotificationReceiver onReceive Delete Call Notification, callId: $callId"
+                )
                 LocalBroadcastManager.getInstance(context.applicationContext)
-                        .sendBroadcast(Intent(ACTION_CALL_NOTIFICATION_CANCELED).putExtra(EXTRA_CALL_ID, callId))
+                    .sendBroadcast(
+                        Intent(ACTION_CALL_NOTIFICATION_CANCELED).putExtra(
+                            EXTRA_CALL_ID,
+                            callId
+                        )
+                    )
             }
         }
     }