Improve Call Screen Behavior on Decline (#1478)

* bugfix: Handle incoming call from  OnNewIntent in StreamCallActivity

* bugfix: Handle incoming call from  OnNewIntent in StreamCallActivity

* bugfix: Handle incoming call from  OnNewIntent in StreamCallActivity

* bugfix: Handle incoming call from  OnNewIntent in StreamCallActivity

* bugfix: Handle Group call rejection on Android

UseCase: Ios is making a group call with 2 android users and one of the android user will decline

* api dump

* api dump

* minor update

* Call reject in bigger lifecycle scope

* fix: Avoid double finish by adding a safe finish

* fix: Deprecate methods which didn't had call object

* temp: Introduce a way to handle multiple calls in the activity.
Pending: This is not backward compatible yet

* temp: Remove deprecation checkpoint 1

* temp: api dump

* temp: Add StreamCallActivityException

* temp: spotless

* temp: spotless

* chore: Update kdoc

* chore: Update kdoc

* chore: Update kdoc

* chore: Update kdoc

* chore: Update kdoc

* chore: Update kdoc

---------

Co-authored-by: Aleksandar Apostolov <apostolov.alexandar@gmail.com>

Author: rahul-lohra

demo-app/src/main/kotlin/io/getstream/video/android/CallActivity.kt

@@ -48,11 +48,11 @@ import kotlinx.coroutines.runBlocking
 class CallActivity : ComposeStreamCallActivity() {
 
     override val uiDelegate: StreamActivityUiDelegate<StreamCallActivity> = StreamDemoUiDelegate()
-    override val configuration: StreamCallActivityConfiguration =
-        StreamCallActivityConfiguration(
-            closeScreenOnCallEnded = false,
-            canSkipPermissionRationale = false,
-        )
+
+    override fun loadConfigFromIntent(intent: Intent?): StreamCallActivityConfiguration {
+        return super.loadConfigFromIntent(intent)
+            .copy(closeScreenOnCallEnded = false, canSkipPermissionRationale = false)
+    }
 
     override fun onNewIntent(intent: Intent) {
         super.onNewIntent(intent)
@@ -144,7 +144,7 @@ class CallActivity : ComposeStreamCallActivity() {
                     flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
                 }
                 startActivity(intent)
-                finish()
+                safeFinish()
             }
         }
     }

demo-app/src/main/kotlin/io/getstream/video/android/MainActivity.kt

@@ -41,10 +41,12 @@ import io.getstream.video.android.tooling.util.StreamBuildFlavorUtil
 import io.getstream.video.android.ui.AppNavHost
 import io.getstream.video.android.ui.AppScreens
 import io.getstream.video.android.ui.common.StreamCallActivity
+import io.getstream.video.android.ui.common.StreamCallActivityConfiguration
 import io.getstream.video.android.util.InAppUpdateHelper
 import io.getstream.video.android.util.InstallReferrer
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.collectLatest
+import kotlinx.coroutines.flow.emptyFlow
 import kotlinx.coroutines.flow.firstOrNull
 import kotlinx.coroutines.flow.flatMapLatest
 import kotlinx.coroutines.flow.flowOf
@@ -104,30 +106,42 @@ class MainActivity : ComponentActivity() {
         observeIncomingCall()
     }
 
+    /**
+     * Observes incoming calls in real-time.
+     *
+     * - First, it waits for the StreamVideo instance to be available.
+     * - Then it watches for a "ringing" call (i.e., someone is calling).
+     * - Once a ringing call is found, it listens for its ringing state updates.
+     * - If the ringing state changes to "Incoming", it means we are receiving a call.
+     * - At that point, it starts the incoming call screen using `startIncomingCallActivity()`.
+     *
+     * This flow automatically stops and restarts if the instance or call changes,
+     * ensuring we always react to the latest incoming call state.
+     */
     @OptIn(ExperimentalCoroutinesApi::class)
     private fun observeIncomingCall() {
         lifecycleScope.launch {
-            StreamVideo.instanceState.flatMapLatest { instance ->
-                instance?.state?.ringingCall ?: flowOf(null)
-            }.collectLatest { call ->
-                if (call != null) {
-                    lifecycleScope.launch {
-                        // Monitor the ringingState on a non-null call
-                        call.state.ringingState.collectLatest {
-                            if (it is RingingState.Incoming) {
-                                startIncomingCallActivity(call)
-                            }
-                        }
+            StreamVideo.instanceState
+                .flatMapLatest { instance ->
+                    instance?.state?.ringingCall ?: flowOf(null)
+                }
+                .flatMapLatest { call ->
+                    call?.state?.ringingState ?: emptyFlow()
+                }
+                .collectLatest { ringingState ->
+                    val currentCall = StreamVideo.instanceState.value?.state?.ringingCall?.value
+                    if (ringingState is RingingState.Incoming) {
+                        currentCall?.let { startIncomingCallActivity(it) }
                     }
                 }
-            }
         }
     }
 
     fun startIncomingCallActivity(call: Call) {
         val intent = StreamCallActivity.callIntent(
             context = this,
             cid = StreamCallId.fromCallCid(call.cid),
+            configuration = StreamCallActivityConfiguration(closeScreenOnCallEnded = true),
             members = emptyList(),
             leaveWhenLastInCall = true,
             action = NotificationHandler.ACTION_INCOMING_CALL,

stream-video-android-core/api/stream-video-android-core.api

@@ -5647,6 +5647,7 @@ public final class io/getstream/video/android/core/CallState {
 	public final fun updateParticipantSortingOrder (Ljava/util/Comparator;)V
 	public final fun updateParticipantVisibility (Ljava/lang/String;Lio/getstream/video/android/core/model/VisibilityOnScreenState;)V
 	public final fun updateParticipantVisibilityFlow (Lkotlinx/coroutines/flow/Flow;)V
+	public final fun updateRejectedBy (Ljava/util/Set;)V
 	public final fun upsertParticipants (Ljava/util/List;)V
 }
 

stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/CallState.kt

@@ -1525,6 +1525,10 @@ public class CallState(
             null
         }
     }
+
+    fun updateRejectedBy(userId: Set<String>) {
+        _rejectedBy.value = userId
+    }
 }
 
 private fun MemberResponse.toMemberState(): MemberState {

stream-video-android-ui-compose/src/main/kotlin/io/getstream/video/android/compose/ui/StreamCallActivityComposeDelegate.kt

@@ -190,7 +190,7 @@ public open class StreamCallActivityComposeDelegate : StreamCallActivityComposeU
                             centerContent = { },
                             onCallAction = {
                                 call.leave()
-                                finish()
+                                safeFinish()
                             },
                         )
                     }
@@ -332,7 +332,7 @@ public open class StreamCallActivityComposeDelegate : StreamCallActivityComposeU
     ) {
         if (!showRationale && configuration.canSkipPermissionRationale) {
             logger.w { "Permissions were not granted, but rationale is required to be skipped." }
-            finish()
+            safeFinish()
         } else {
             PermissionsRationaleContent(call, granted, notGranted)
         }
@@ -355,7 +355,7 @@ public open class StreamCallActivityComposeDelegate : StreamCallActivityComposeU
                     CallDisconnectedContent(call)
                 } else {
                     // This is just for safety, will be called from other place as well.
-                    finish()
+                    safeFinish()
                 }
             }
 
@@ -365,7 +365,7 @@ public open class StreamCallActivityComposeDelegate : StreamCallActivityComposeU
                     CallFailedContent(call, err)
                 } else {
                     // This is just for safety, will be called from other place as well.
-                    finish()
+                    safeFinish()
                 }
             }
 
@@ -472,14 +472,14 @@ public open class StreamCallActivityComposeDelegate : StreamCallActivityComposeU
     override fun StreamCallActivity.CallFailedContent(call: Call, exception: java.lang.Exception) {
         // By default we finish the activity regardless of config.
         // There is not default UI for call failed content.
-        finish()
+        safeFinish()
     }
 
     @Composable
     override fun StreamCallActivity.CallDisconnectedContent(call: Call) {
         // By default we finish the activity regardless of config.
         // There is not default UI for call ended content.
-        finish()
+        safeFinish()
     }
 
     @Composable