Introduce NotificationActionsFactory (#6037)

VelikovPetar · web-flow · commit 5a927f9cf343 · 2025-12-12T09:33:58.000Z
* Introduce NotificationActionsFactory.

* Update CHANGELOG.md.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,6 +21,7 @@
 - Add `ChatClient.markThreadUnread(String, String, String)` for marking a thread as unread. [#6027](https://github.com/GetStream/stream-chat-android/pull/6027)
 - Add `ChannelClient.markUnread(Date)` for marking a channel as unread from a given timestamp. [#6027](https://github.com/GetStream/stream-chat-android/pull/6027)
 - Add `ChannelClient.markThreadUnread(String)` for marking a thread as unread. [#6027](https://github.com/GetStream/stream-chat-android/pull/6027)
+- Add `NotificationActionsFactory` for building and customizing the default notification actions. [#6037](https://github.com/GetStream/stream-chat-android/pull/6037)
 
 ### ⚠️ Changed
 - Deprecate `ChatClient.markThreadUnread(String, String, String, String)` because marking a thread as unread from a given message is currently not supported. [#6027](https://github.com/GetStream/stream-chat-android/pull/6027)
diff --git a/stream-chat-android-client/api/stream-chat-android-client.api b/stream-chat-android-client/api/stream-chat-android-client.api
@@ -2874,6 +2874,14 @@ public final class io/getstream/chat/android/client/notifications/handler/ChatNo
 	public fun toString ()Ljava/lang/String;
 }
 
+public final class io/getstream/chat/android/client/notifications/handler/NotificationActionsFactory {
+	public static final field INSTANCE Lio/getstream/chat/android/client/notifications/handler/NotificationActionsFactory;
+	public final fun createMarkReadAction (Landroid/content/Context;ILio/getstream/chat/android/models/Channel;Lio/getstream/chat/android/models/Message;ILjava/lang/String;Landroid/app/PendingIntent;)Landroidx/core/app/NotificationCompat$Action;
+	public static synthetic fun createMarkReadAction$default (Lio/getstream/chat/android/client/notifications/handler/NotificationActionsFactory;Landroid/content/Context;ILio/getstream/chat/android/models/Channel;Lio/getstream/chat/android/models/Message;ILjava/lang/String;Landroid/app/PendingIntent;ILjava/lang/Object;)Landroidx/core/app/NotificationCompat$Action;
+	public final fun createReplyAction (Landroid/content/Context;ILio/getstream/chat/android/models/Channel;ILjava/lang/String;Ljava/lang/String;Landroid/app/PendingIntent;)Landroidx/core/app/NotificationCompat$Action;
+	public static synthetic fun createReplyAction$default (Lio/getstream/chat/android/client/notifications/handler/NotificationActionsFactory;Landroid/content/Context;ILio/getstream/chat/android/models/Channel;ILjava/lang/String;Ljava/lang/String;Landroid/app/PendingIntent;ILjava/lang/Object;)Landroidx/core/app/NotificationCompat$Action;
+}
+
 public final class io/getstream/chat/android/client/notifications/handler/NotificationConfig {
 	public fun <init> ()V
 	public fun <init> (Z)V
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/handler/NotificationActionsFactory.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/handler/NotificationActionsFactory.kt
@@ -0,0 +1,135 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.getstream.chat.android.client.notifications.handler
+
+import android.app.PendingIntent
+import android.content.Context
+import androidx.annotation.DrawableRes
+import androidx.core.app.NotificationCompat
+import io.getstream.chat.android.client.R
+import io.getstream.chat.android.client.receivers.NotificationMessageReceiver
+import io.getstream.chat.android.models.Channel
+import io.getstream.chat.android.models.Message
+
+/**
+ * Factory for creating [NotificationCompat.Action] instances used in chat push notifications.
+ *
+ * This factory provides convenient methods to create common notification actions such as
+ * "Mark as Read" and "Reply" with sensible defaults, while allowing full customization.
+ *
+ * @see NotificationCompat.Action
+ */
+public object NotificationActionsFactory {
+
+    /**
+     * Creates a "Mark as Read" notification action.
+     *
+     * When triggered, this action marks the specified message as read in the channel.
+     *
+     * @param context The [Context] used to access resources and create the pending intent.
+     * @param notificationId The unique identifier for the notification. Used for the pending intent request code.
+     * @param channel The [Channel] containing the message to mark as read.
+     * @param message The [Message] to mark as read when the action is triggered.
+     * @param icon The drawable resource ID for the action icon. Defaults to [android.R.drawable.ic_menu_view].
+     * @param title The label text displayed on the action button. Defaults to the localized "Mark as read" string.
+     * @param pendingIntent The [PendingIntent] to execute when the action is triggered. Defaults to a broadcast intent
+     * which will mark the channel as read.
+     * @return A [NotificationCompat.Action] configured for marking messages as read.
+     */
+    public fun createMarkReadAction(
+        context: Context,
+        notificationId: Int,
+        channel: Channel,
+        message: Message,
+        @DrawableRes icon: Int = android.R.drawable.ic_menu_view,
+        title: String = context.getString(R.string.stream_chat_notification_read),
+        pendingIntent: PendingIntent = createMarkReadPendingIntent(context, notificationId, channel, message),
+    ): NotificationCompat.Action {
+        return NotificationMessageReceiver.createMarkReadAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            message = message,
+            icon = icon,
+            title = title,
+            pendingIntent = pendingIntent,
+        )
+    }
+
+    /**
+     * Creates a "Reply" notification action with inline reply support.
+     *
+     * This action displays an inline text input field (on supported devices) allowing users
+     * to reply directly from the notification without opening the app.
+     *
+     * @param context The [Context] used to access resources and create the pending intent.
+     * @param notificationId The unique identifier for the notification. Used for the pending intent request code.
+     * @param channel The [Channel] to send the reply message to.
+     * @param icon The drawable resource ID for the action icon. Defaults to [android.R.drawable.ic_menu_send].
+     * @param title The label text displayed on the action button. Defaults to the localized "Reply" string.
+     * @param hint The placeholder text shown in the inline reply input field. Defaults to the localized
+     * "Type a message" string.
+     * @param pendingIntent The [PendingIntent] to execute when the reply is submitted. Defaults to a broadcast intent
+     * which sends a message in the channel.
+     * @return A [NotificationCompat.Action] configured for inline reply.
+     */
+    public fun createReplyAction(
+        context: Context,
+        notificationId: Int,
+        channel: Channel,
+        @DrawableRes icon: Int = android.R.drawable.ic_menu_send,
+        title: String = context.getString(R.string.stream_chat_notification_reply),
+        hint: String = context.getString(R.string.stream_chat_notification_type_hint),
+        pendingIntent: PendingIntent = createReplyPendingIntent(context, notificationId, channel),
+    ): NotificationCompat.Action {
+        return NotificationMessageReceiver.createReplyAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            icon = icon,
+            title = title,
+            hint = hint,
+            pendingIntent = pendingIntent,
+        )
+    }
+
+    private fun createMarkReadPendingIntent(
+        context: Context,
+        notificationId: Int,
+        channel: Channel,
+        message: Message,
+    ): PendingIntent {
+        return NotificationMessageReceiver.createMarkReadPendingIntent(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            message = message,
+        )
+    }
+
+    private fun createReplyPendingIntent(
+        context: Context,
+        notificationId: Int,
+        channel: Channel,
+    ): PendingIntent {
+        return NotificationMessageReceiver.createReplyPendingIntent(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+        )
+    }
+}
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/handler/NotificationHandlerFactory.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/notifications/handler/NotificationHandlerFactory.kt
@@ -29,7 +29,6 @@ import androidx.core.graphics.drawable.IconCompat
 import io.getstream.android.push.permissions.DefaultNotificationPermissionHandler
 import io.getstream.android.push.permissions.NotificationPermissionHandler
 import io.getstream.chat.android.client.R
-import io.getstream.chat.android.client.receivers.NotificationMessageReceiver
 import io.getstream.chat.android.models.Channel
 import io.getstream.chat.android.models.Message
 import io.getstream.chat.android.models.PushMessage
@@ -54,6 +53,7 @@ public object NotificationHandlerFactory {
      * @param permissionHandler Handles [android.Manifest.permission.POST_NOTIFICATIONS] permission lifecycle.
      * @param notificationTextFormatter Lambda expression used to formats the text of the notification.
      * @param actionsProvider Lambda expression used to provide actions for the notification.
+     * See [NotificationActionsFactory] for customizing the default actions.
      * @param notificationBuilderTransformer Lambda expression used to transform the [NotificationCompat.Builder]
      * before building the notification.
      * @param onPushMessage Lambda expression called when a new push message is received. Return true if the
@@ -108,8 +108,8 @@ public object NotificationHandlerFactory {
     ): (notificationId: Int, channel: Channel, message: Message) -> List<NotificationCompat.Action> =
         { notificationId, channel, message ->
             listOf(
-                NotificationMessageReceiver.createReadAction(context, notificationId, channel, message),
-                NotificationMessageReceiver.createReplyAction(context, notificationId, channel),
+                NotificationActionsFactory.createMarkReadAction(context, notificationId, channel, message),
+                NotificationActionsFactory.createReplyAction(context, notificationId, channel),
             )
         }
 
diff --git a/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receivers/NotificationMessageReceiver.kt b/stream-chat-android-client/src/main/java/io/getstream/chat/android/client/receivers/NotificationMessageReceiver.kt
@@ -21,6 +21,7 @@ import android.content.BroadcastReceiver
 import android.content.Context
 import android.content.Intent
 import android.os.Build
+import androidx.annotation.DrawableRes
 import androidx.core.app.NotificationCompat
 import androidx.core.app.RemoteInput
 import io.getstream.chat.android.client.ChatClient
@@ -55,7 +56,7 @@ internal class NotificationMessageReceiver : BroadcastReceiver() {
                 PendingIntent.FLAG_UPDATE_CURRENT
             }
 
-        private fun createReplyPendingIntent(
+        internal fun createReplyPendingIntent(
             context: Context,
             notificationId: Int,
             channel: Channel,
@@ -67,7 +68,7 @@ internal class NotificationMessageReceiver : BroadcastReceiver() {
                 MUTABLE_PENDING_INTENT_FLAGS,
             )
 
-        private fun createReadPendingIntent(
+        internal fun createMarkReadPendingIntent(
             context: Context,
             notificationId: Int,
             channel: Channel,
@@ -92,33 +93,32 @@ internal class NotificationMessageReceiver : BroadcastReceiver() {
             IMMUTABLE_PENDING_INTENT_FLAGS,
         )
 
-        internal fun createReadAction(
+        internal fun createMarkReadAction(
             context: Context,
             notificationId: Int,
             channel: Channel,
             message: Message,
+            @DrawableRes icon: Int = android.R.drawable.ic_menu_view,
+            title: String = context.getString(R.string.stream_chat_notification_read),
+            pendingIntent: PendingIntent = createMarkReadPendingIntent(context, notificationId, channel, message),
         ): NotificationCompat.Action {
-            return NotificationCompat.Action.Builder(
-                android.R.drawable.ic_menu_view,
-                context.getString(R.string.stream_chat_notification_read),
-                createReadPendingIntent(context, notificationId, channel, message),
-            ).build()
+            return NotificationCompat.Action.Builder(icon, title, pendingIntent).build()
         }
 
         internal fun createReplyAction(
             context: Context,
             notificationId: Int,
             channel: Channel,
+            @DrawableRes icon: Int = android.R.drawable.ic_menu_send,
+            title: String = context.getString(R.string.stream_chat_notification_reply),
+            hint: String = context.getString(R.string.stream_chat_notification_type_hint),
+            pendingIntent: PendingIntent = createReplyPendingIntent(context, notificationId, channel),
         ): NotificationCompat.Action {
             val remoteInput =
                 RemoteInput.Builder(KEY_TEXT_REPLY)
-                    .setLabel(context.getString(R.string.stream_chat_notification_type_hint))
+                    .setLabel(hint)
                     .build()
-            return NotificationCompat.Action.Builder(
-                android.R.drawable.ic_menu_send,
-                context.getString(R.string.stream_chat_notification_reply),
-                createReplyPendingIntent(context, notificationId, channel),
-            )
+            return NotificationCompat.Action.Builder(icon, title, pendingIntent)
                 .addRemoteInput(remoteInput)
                 .setAllowGeneratedReplies(true)
                 .build()
diff --git a/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/notifications/handler/NotificationActionsFactoryTest.kt b/stream-chat-android-client/src/test/java/io/getstream/chat/android/client/notifications/handler/NotificationActionsFactoryTest.kt
@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-chat-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.getstream.chat.android.client.notifications.handler
+
+import android.app.PendingIntent
+import android.content.Context
+import androidx.test.core.app.ApplicationProvider
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import io.getstream.chat.android.client.R
+import io.getstream.chat.android.randomChannel
+import io.getstream.chat.android.randomInt
+import io.getstream.chat.android.randomMessage
+import io.getstream.chat.android.randomString
+import org.junit.Assert.assertEquals
+import org.junit.Assert.assertNotNull
+import org.junit.Assert.assertTrue
+import org.junit.Before
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.mockito.kotlin.mock
+import org.robolectric.annotation.Config
+
+@RunWith(AndroidJUnit4::class)
+@Config(sdk = [33])
+internal class NotificationActionsFactoryTest {
+
+    private lateinit var context: Context
+
+    @Before
+    fun setUp() {
+        context = ApplicationProvider.getApplicationContext()
+    }
+
+    @Test
+    fun `createMarkReadAction should return action with default values`() {
+        val notificationId = randomInt()
+        val channel = randomChannel()
+        val message = randomMessage()
+
+        val action = NotificationActionsFactory.createMarkReadAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            message = message,
+        )
+
+        assertNotNull(action)
+        assertEquals(android.R.drawable.ic_menu_view, action.iconCompat?.resId)
+        assertEquals(context.getString(R.string.stream_chat_notification_read), action.title.toString())
+        assertNotNull(action.actionIntent)
+    }
+
+    @Test
+    fun `createMarkReadAction should return action with custom values`() {
+        val notificationId = randomInt()
+        val channel = randomChannel()
+        val message = randomMessage()
+        val customIcon = android.R.drawable.ic_menu_close_clear_cancel
+        val customTitle = randomString()
+        val customPendingIntent: PendingIntent = mock()
+
+        val action = NotificationActionsFactory.createMarkReadAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            message = message,
+            icon = customIcon,
+            title = customTitle,
+            pendingIntent = customPendingIntent,
+        )
+
+        assertNotNull(action)
+        assertEquals(customIcon, action.iconCompat?.resId)
+        assertEquals(customTitle, action.title.toString())
+        assertEquals(customPendingIntent, action.actionIntent)
+    }
+
+    @Test
+    fun `createReplyAction should return action with default values`() {
+        val notificationId = randomInt()
+        val channel = randomChannel()
+
+        val action = NotificationActionsFactory.createReplyAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+        )
+
+        assertNotNull(action)
+        assertEquals(android.R.drawable.ic_menu_send, action.iconCompat?.resId)
+        assertEquals(context.getString(R.string.stream_chat_notification_reply), action.title.toString())
+        assertNotNull(action.actionIntent)
+        assertNotNull(action.remoteInputs)
+        assertTrue(action.remoteInputs!!.isNotEmpty())
+        assertTrue(action.allowGeneratedReplies)
+    }
+
+    @Test
+    fun `createReplyAction should return action with custom values`() {
+        val notificationId = randomInt()
+        val channel = randomChannel()
+        val customIcon = android.R.drawable.ic_menu_edit
+        val customTitle = randomString()
+        val customPendingIntent: PendingIntent = mock()
+
+        val action = NotificationActionsFactory.createReplyAction(
+            context = context,
+            notificationId = notificationId,
+            channel = channel,
+            icon = customIcon,
+            title = customTitle,
+            pendingIntent = customPendingIntent,
+        )
+
+        assertNotNull(action)
+        assertEquals(customIcon, action.iconCompat?.resId)
+        assertEquals(customTitle, action.title.toString())
+        assertEquals(customPendingIntent, action.actionIntent)
+    }
+}
