Add ChatClient.markMessagesAsDelivered function to mark messages as delivered

Author: andremion

stream-chat-android-client/api/stream-chat-android-client.api

@@ -112,6 +112,7 @@ public final class io/getstream/chat/android/client/ChatClient {
 	public static synthetic fun keystroke$default (Lio/getstream/chat/android/client/ChatClient;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/result/call/Call;
 	public final fun markAllRead ()Lio/getstream/result/call/Call;
 	public final fun markMessageRead (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
+	public final fun markMessagesAsDelivered (Ljava/util/List;)Lio/getstream/result/call/Call;
 	public final fun markRead (Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun markThreadRead (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;
 	public final fun markThreadUnread (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)Lio/getstream/result/call/Call;

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/ChatClient.kt

@@ -2882,6 +2882,22 @@ internal constructor(
             }
     }
 
+    /**
+     * Marks the given messages as delivered.
+     *
+     * @param messages The list of messages to mark as delivered.
+     */
+    @CheckResult
+    public fun markMessagesAsDelivered(messages: List<Message>): Call<Unit> {
+        return api.markDelivered(messages)
+            .doOnStart(userScope) {
+                logger.d { "[markMessagesAsDelivered] #doOnStart; messages: ${messages.size}" }
+            }
+            .doOnResult(userScope) { result ->
+                logger.v { "[markMessagesAsDelivered] #doOnResult; completed: $result" }
+            }
+    }
+
     /**
      * Marks a given thread as read.
      *

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api/ChatApi.kt

@@ -338,6 +338,11 @@ internal interface ChatApi {
         messageId: String = "",
     ): Call<Unit>
 
+    @CheckResult
+    fun markDelivered(
+        messages: List<Message>,
+    ): Call<Unit>
+
     @CheckResult
     fun markThreadRead(
         channelType: String,

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/MoshiChatApi.kt

@@ -57,6 +57,7 @@ import io.getstream.chat.android.client.api2.model.requests.FlagUserRequest
 import io.getstream.chat.android.client.api2.model.requests.GuestUserRequest
 import io.getstream.chat.android.client.api2.model.requests.HideChannelRequest
 import io.getstream.chat.android.client.api2.model.requests.InviteMembersRequest
+import io.getstream.chat.android.client.api2.model.requests.MarkDeliveredRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkReadRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkUnreadRequest
 import io.getstream.chat.android.client.api2.model.requests.MuteChannelRequest
@@ -960,6 +961,11 @@ constructor(
         ).toUnitCall()
     }
 
+    override fun markDelivered(messages: List<Message>): Call<Unit> =
+        channelApi.markDelivered(
+            request = MarkDeliveredRequest.create(messages),
+        ).toUnitCall()
+
     override fun markThreadRead(channelType: String, channelId: String, threadId: String): Call<Unit> {
         return channelApi.markRead(
             channelType = channelType,

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/endpoint/ChannelApi.kt

@@ -23,6 +23,7 @@ import io.getstream.chat.android.client.api2.model.requests.AcceptInviteRequest
 import io.getstream.chat.android.client.api2.model.requests.AddMembersRequest
 import io.getstream.chat.android.client.api2.model.requests.HideChannelRequest
 import io.getstream.chat.android.client.api2.model.requests.InviteMembersRequest
+import io.getstream.chat.android.client.api2.model.requests.MarkDeliveredRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkReadRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkUnreadRequest
 import io.getstream.chat.android.client.api2.model.requests.PinnedMessagesRequest
@@ -211,4 +212,9 @@ internal interface ChannelApi {
         @Path("id") channelId: String,
         @UrlQueryPayload @Query("payload") payload: PinnedMessagesRequest,
     ): RetrofitCall<MessagesResponse>
+
+    @POST("/channels/delivered")
+    fun markDelivered(
+        @Body request: MarkDeliveredRequest,
+    ): RetrofitCall<CompletableResponse>
 }

stream-chat-android-client/src/main/java/io/getstream/chat/android/client/api2/model/requests/MarkDeliveredRequest.kt

@@ -0,0 +1,42 @@
+/*
+ * 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.api2.model.requests
+
+import com.squareup.moshi.JsonClass
+import io.getstream.chat.android.models.Message
+
+@JsonClass(generateAdapter = true)
+internal data class MarkDeliveredRequest(
+    val latest_delivered_messages: List<DeliveredMessageDto>,
+) {
+    companion object {
+        fun create(messages: List<Message>) = MarkDeliveredRequest(
+            latest_delivered_messages = messages.map { info ->
+                DeliveredMessageDto(
+                    cid = info.cid,
+                    id = info.id,
+                )
+            },
+        )
+    }
+}
+
+@JsonClass(generateAdapter = true)
+internal data class DeliveredMessageDto(
+    val cid: String,
+    val id: String,
+)

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/ChatClientChannelApiTests.kt

@@ -44,6 +44,7 @@ import io.getstream.chat.android.randomExtraData
 import io.getstream.chat.android.randomInt
 import io.getstream.chat.android.randomMember
 import io.getstream.chat.android.randomMessage
+import io.getstream.chat.android.randomMessageList
 import io.getstream.chat.android.randomString
 import io.getstream.chat.android.randomUser
 import io.getstream.result.Error
@@ -987,6 +988,33 @@ internal class ChatClientChannelApiTests : BaseChatClientTest() {
         verifyNetworkError(result, errorCode)
     }
 
+    @Test
+    fun markMessagesAsDeliveredSuccess() = runTest {
+        // given
+        val messages = randomMessageList(10)
+        val sut = Fixture()
+            .givenMarkDeliveredResult(RetroSuccess(Unit).toRetrofitCall())
+            .get()
+        // when
+        val result = sut.markMessagesAsDelivered(messages).await()
+        // then
+        verifySuccess(result, Unit)
+    }
+
+    @Test
+    fun markMessagesAsDeliveredError() = runTest {
+        // given
+        val messages = randomMessageList(10)
+        val errorCode = positiveRandomInt()
+        val sut = Fixture()
+            .givenMarkDeliveredResult(RetroError<Unit>(errorCode).toRetrofitCall())
+            .get()
+        // when
+        val result = sut.markMessagesAsDelivered(messages).await()
+        // then
+        verifyNetworkError(result, errorCode)
+    }
+
     @Test
     fun markReadSuccess() = runTest {
         // given
@@ -1528,6 +1556,10 @@ internal class ChatClientChannelApiTests : BaseChatClientTest() {
             whenever(api.markRead(any(), any(), any())).thenReturn(result)
         }
 
+        fun givenMarkDeliveredResult(result: Call<Unit>) = apply {
+            whenever(api.markDelivered(any())).thenReturn(result)
+        }
+
         fun givenMarkUnreadResult(result: Call<Unit>) = apply {
             whenever(api.markUnread(any(), any(), any())).thenReturn(result)
         }

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTest.kt

@@ -46,10 +46,12 @@ import io.getstream.chat.android.client.api2.model.requests.AcceptInviteRequest
 import io.getstream.chat.android.client.api2.model.requests.AddDeviceRequest
 import io.getstream.chat.android.client.api2.model.requests.BanUserRequest
 import io.getstream.chat.android.client.api2.model.requests.BlockUserRequest
+import io.getstream.chat.android.client.api2.model.requests.DeliveredMessageDto
 import io.getstream.chat.android.client.api2.model.requests.FlagMessageRequest
 import io.getstream.chat.android.client.api2.model.requests.FlagUserRequest
 import io.getstream.chat.android.client.api2.model.requests.GuestUserRequest
 import io.getstream.chat.android.client.api2.model.requests.HideChannelRequest
+import io.getstream.chat.android.client.api2.model.requests.MarkDeliveredRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkReadRequest
 import io.getstream.chat.android.client.api2.model.requests.MarkUnreadRequest
 import io.getstream.chat.android.client.api2.model.requests.MuteChannelRequest
@@ -147,6 +149,7 @@ import io.getstream.chat.android.randomInt
 import io.getstream.chat.android.randomMember
 import io.getstream.chat.android.randomMemberData
 import io.getstream.chat.android.randomMessage
+import io.getstream.chat.android.randomMessageList
 import io.getstream.chat.android.randomPollConfig
 import io.getstream.chat.android.randomReaction
 import io.getstream.chat.android.randomString
@@ -1389,6 +1392,31 @@ internal class MoshiChatApiTest {
         verify(api, times(1)).markRead(channelType, channelId, expectedRequest)
     }
 
+    @ParameterizedTest
+    @MethodSource("io.getstream.chat.android.client.api2.MoshiChatApiTestArguments#markDeliveredInput")
+    fun testMarkDelivered(call: RetrofitCall<CompletableResponse>, expected: KClass<*>) = runTest {
+        // given
+        val api = mock<ChannelApi>()
+        whenever(api.markDelivered(any())).doReturn(call)
+        val sut = Fixture()
+            .withChannelApi(api)
+            .get()
+        // when
+        val messages = randomMessageList(10)
+        val result = sut.markDelivered(messages).await()
+        // then
+        val expectedRequest = MarkDeliveredRequest(
+            latest_delivered_messages = messages.map { messageInfo ->
+                DeliveredMessageDto(
+                    cid = messageInfo.cid,
+                    id = messageInfo.id,
+                )
+            },
+        )
+        result `should be instance of` expected
+        verify(api, times(1)).markDelivered(expectedRequest)
+    }
+
     @ParameterizedTest
     @MethodSource("io.getstream.chat.android.client.api2.MoshiChatApiTestArguments#markThreadReadInput")
     fun testMarkThreadRead(call: RetrofitCall<CompletableResponse>, expected: KClass<*>) = runTest {

stream-chat-android-client/src/test/java/io/getstream/chat/android/client/api2/MoshiChatApiTestArguments.kt

@@ -304,6 +304,9 @@ internal object MoshiChatApiTestArguments {
     @JvmStatic
     fun markReadInput() = completableResponseArguments()
 
+    @JvmStatic
+    fun markDeliveredInput() = completableResponseArguments()
+
     @JvmStatic
     fun markThreadReadInput() = completableResponseArguments()