Forward the original push payload into the notification handler

[rahul-lohra]

🎯 Goal

1. Propagate push payload from FCM down to our Notification APIs
2. Customizing PendingIntent Bundles

Propagate push payload from FCM down to our Notification APIs

Enhance the notification handling flow by forwarding the full push notification payload (key-value pairs) to the StreamNotificationHandler interface.
This allows client applications to access the original push payload and consume custom fields (e.g., dynamic titles, metadata) directly, which was not possible before.

🛠 Implementation details

Existing API will new extend new interface which has payload:Map<String, Any?>

---

// ========================================
// NEW APIs (with payload)
// ========================================

// StreamNotificationHandlerWithPayload
fun onRingingCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)
fun onMissedCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)
fun onNotification(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)
fun onLiveCall(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>)

// StreamNotificationProviderWithPayload
fun getIncomingCallNotification(..., payload: Map<String, Any?>)
fun getOngoingCallNotification(..., payload: Map<String, Any?>)
fun getRingingCallNotification(..., payload: Map<String, Any?>)
fun getMissedCallNotification(..., payload: Map<String, Any?>)

// StreamNotificationBuilderInterceptorsWithPayload
fun onBuildIncomingCallNotification(..., payload: Map<String, Any?>)
fun onBuildOngoingCallNotification(..., payload: Map<String, Any?>)
fun onBuildMissedCallNotification(..., payload: Map<String, Any?>)
fun onBuildOutgoingCallNotification(..., payload: Map<String, Any?>)


// ========================================
// DEPRECATED APIs (without payload)
// ========================================

// StreamNotificationHandler
fun onRingingCall(callId: StreamCallId, callDisplayName: String)
fun onMissedCall(callId: StreamCallId, callDisplayName: String)
fun onNotification(callId: StreamCallId, callDisplayName: String)
fun onLiveCall(callId: StreamCallId, callDisplayName: String)

// StreamNotificationProvider
fun getIncomingCallNotification(..., shouldHaveContentIntent: Boolean)
fun getOngoingCallNotification(callId: StreamCallId, callDisplayName: String?, isOutgoingCall: Boolean, remoteParticipantCount: Int)
fun getRingingCallNotification(ringingState: RingingState, callId: StreamCallId, callDisplayName: String?, shouldHaveContentIntent: Boolean)
fun getMissedCallNotification(callId: StreamCallId, callDisplayName: String?)

// StreamNotificationBuilderInterceptors
fun onBuildIncomingCallNotification(...)
fun onBuildOngoingCallNotification(...)
fun onBuildMissedCallNotification(...)
fun onBuildOutgoingCallNotification(...)

Customizing PendingIntent Bundles

We’ve introduced new APIs that allow client applications to customize the Bundle attached to PendingIntents.
This enables you to:

• Control behaviors such as "last leave" policy and other configurations.
• Pass custom key–value pairs directly to StreamCallActivity.

Implementation Details

• Added two new interfaces:

  • StreamIntentResolverWithPayload
  • NotificationIntentBundleResolver
    These are used internally by the Notification Handler.

• Provided a DefaultNotificationIntentBundleResolver, which can be supplied during SDK initialization.

// ========================================
// NEW APIs (with payload)
// ========================================

// StreamIntentResolverWithPayload
fun searchIncomingCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchOutgoingCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchNotificationCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun getDefaultPendingIntent(payload: Map<String, Any?>): PendingIntent?
fun searchLiveCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchAcceptCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchRejectCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchEndCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?
fun searchOngoingCallPendingIntent(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): PendingIntent?

// ========================================
// DEPRECATED APIs (without payload)
// ========================================

//StreamIntentResolver
fun searchIncomingCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchOutgoingCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchNotificationCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun getDefaultPendingIntent(): PendingIntent?
fun searchLiveCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchAcceptCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchRejectCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchEndCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?
fun searchOngoingCallPendingIntent(callId: StreamCallId, callDisplayName: String): PendingIntent?

// ========================================
// NEW APIs (with payload)
// ========================================
//NotificationIntentBundleResolver
fun getIncomingCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle   
fun getOutgoingCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle
fun getNotificationCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle
fun getMissedCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle
fun getDefaultBundle(payload: Map<String, Any?>): Bundle
fun getLiveCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle
fun getAcceptCallBundle(callId: StreamCallId, callDisplayName: String, payload: Map<String, Any?>): Bundle
fun getRejectCallBundle(callId: StreamCallId, payload: Map<String, Any?>): Bundle
fun getEndCallPendingBundle(callId: StreamCallId, payload: Map<String, Any?>): Bundle
fun getOngoingCallBundle(callId: StreamCallId, notificationId: Int, payload: Map<String, Any?>): Bundle

Client Usage

Here is an example on how you can customise the bundle for accect and reject bundle on the incoming call
We will extend DefaultNotificationIntentBundleResolver and override getAcceptCallBundle and getRejectCallBundle

To simplify creating a base bundle for StreamCallActivity, you can use the helper method:

StreamCallActivity.callIntentBundle(...)

private fun initializeStreamVideo(context: Context): StreamVideo {        
        return StreamVideoBuilder(               
                notificationHandler = CompatibilityStreamNotificationHandler(
                    application = context.applicationContext,
                    intentResolver = DefaultStreamIntentResolver(
                        context,
                        object : DefaultNotificationIntentBundleResolver() {

                            override fun getAcceptCallBundle(
                                callId: StreamCallId,
                                notificationId: Int,
                                payload: Map<String, Any?>,
                            ): Bundle {
                                return StreamCallActivity.callIntentBundle(
                                    callId,
                                    configuration = StreamCallActivityConfiguration(
                                        closeScreenOnCallEnded = true,
                                    ),
                                    leaveWhenLastInCall = true,
                                )
                            }

                            override fun getRejectCallBundle(
                                callId: StreamCallId,
                                payload: Map<String, Any?>,
                            ): Bundle {
                                return StreamCallActivity.callIntentBundle(
                                    callId,
                                    configuration = StreamCallActivityConfiguration(
                                        closeScreenOnCallEnded = true,
                                    ),
                                    leaveWhenLastInCall = true,
                                )
                            }
                        },
                    ),
                ),
            ),        
        ).build()
    }

[github-actions]

SDK Size Comparison 📏

SDK	Before	After	Difference	Status
stream-video-android-core	11.43 MB	11.43 MB	0.00 MB	🟢
stream-video-android-ui-xml	5.68 MB	5.70 MB	0.02 MB	🟢
stream-video-android-ui-compose	5.88 MB	5.88 MB	0.00 MB	🟢

[sonarqubecloud]

Quality Gate failed

Failed conditions
37.1% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube Cloud