Add KDocs to getNotificationUpdates

GetStream · Sep 20, 2024 · 6e07c0f · 6e07c0f
1 parent fabb6dc
commit 6e07c0f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/...core/src/main/kotlin/io/getstream/video/android/core/notifications/NotificationHandler.kt b/...core/src/main/kotlin/io/getstream/video/android/core/notifications/NotificationHandler.kt
@@ -42,6 +42,16 @@ public interface NotificationHandler : NotificationPermissionHandler {
         shouldHaveContentIntent: Boolean = true,
     ): Notification?
     fun getSettingUpCallNotification(): Notification?
+
+    /**
+     * Get subsequent updates to notifications.
+     * Initially, notifications are posted by one of the other methods, and then this method can be used to re-post them with updated content.
+     *
+     * @param coroutineScope Coroutine scope used for the updates.
+     * @param call The Stream call object.
+     * @param localUser The local Stream user.
+     * @param onUpdate Callback to be called when the notification is updated.
+     */
     fun getNotificationUpdates(
         coroutineScope: CoroutineScope,
         call: Call,