chore(android-core): update chat docs with v2 changes

Yash-Garg · Yash-Garg · commit 353ef32c214d · 2024-12-17T16:55:03.000+05:30
diff --git a/docs/android-core/chat/introduction.mdx b/docs/android-core/chat/introduction.mdx
@@ -1,5 +1,5 @@
 ---
-title: Introducing chat
+title: Introduction
 description: >-
   Learn the basics of integrating Dyte's chat functionality into your Android
   application – a step towards immersive real-time communication.
@@ -29,7 +29,8 @@ class DyteTextMessage(
   pluginId: String?,
   val message: String,
   time: String,
-  channelId: String? = null,
+  createdAtMillis: Long,
+  targetUserIds: List<String>?,
 )
 ```
 
@@ -43,7 +44,8 @@ class DyteImageMessage(
   pluginId: String?,
   val link: String,
   time: String,
-  channelId: String? = null,
+  createdAtMillis: Long,
+  targetUserIds: List<String>?,
 )
 ```
 
@@ -57,9 +59,10 @@ class DyteFileMessage(
   pluginId: String?,
   val name: String,
   time: String,
+  createdAtMillis: Long,
   val link: String,
   val size: Long,
-  channelId: String? = null,
+  targetUserIds: List<String>?,
 )
 ```
 
diff --git a/docs/android-core/chat/receiving-chat-messages.mdx b/docs/android-core/chat/receiving-chat-messages.mdx
@@ -20,19 +20,25 @@ subscribe to this events by calling
 meeting.addChatEventsListener(object :
   DyteChatEventsListener {
     override fun onChatUpdates(messages: List<DyteChatMessage>) {
-     // to load chat messages
+      // to load chat messages
     }
 
     override fun onNewChatMessage(message: DyteChatMessage) {
       // when a new chat message is shared in the meeting
     }
+
+    override fun onMessageRateLimitReset() {
+      // when the rate limit for sending messages of self is reset
+    }
   })
 ```
 
 The `onChatUpdates()` method will be called whenever there is a change in the chat messages. The `messages` parameter is a list of `DyteChatMessage` objects that have been sent in the chat.
 
 The `onNewChatMessage()` method will be called whenever a new chat message is shared in the meeting. The `message` parameter is a `DyteChatMessage` object that has been sent in the chat.
 
+The `onMessageRateLimitReset()` method will be called when the rate limit for sending messages of self is reset and you can send messages again.
+
 <head>
   <title>Android Core Receiving chat</title>
 </head>
diff --git a/docs/android-core/chat/sending-a-chat-message.mdx b/docs/android-core/chat/sending-a-chat-message.mdx
@@ -28,19 +28,44 @@ You can send an image with the help of `meeting.chat.sendImageMessage()` and
 sends it to the participants in the meeting.
 
 ```kotlin
-val filePath = "file_path_of_image"
-val fileName = "file_name"
-meeting.chat.sendImageMessage(filePath, fileName)
+meeting.chat.sendImageMessage(fileUri) { err ->
+  // Handle error if any
+}
 ```
 
 ## Send a file
 
 Sending a file is quite similar to sending an image. The only difference is that when you send an image, a preview will be shown in the meeting chat, which is not the case for sending files. That being said, an image can be sent as a file too using `meeting.chat.sendFileMessage()`.
 
 ```kotlin
-val filePath = "file_path_of_image"
-val fileName = "file_name"
-meeting.chat.sendFileMessage(filePath, fileName)
+meeting.chat.sendFileMessage(fileUri) { err ->
+  // Handle error if any
+}
+```
+
+## Error types
+
+Both `sendImageMessage` and `sendFileMessage` methods accept a callback function that will be called with an error object if there is an error while sending the message.
+
+The error object is of type `ChatFileError`, which can be classified into the following:
+
+- FileFormatNotAllowed
+- PermissionDenied
+- RateLimitBreached
+- ReadFailed
+- UploadFailed
+
+A `when` block can be used to handle these errors inside the callback, as shown below:
+
+```kotlin
+when (err) {
+  is ChatFileError.FileFormatNotAllowed -> {}
+  is ChatFileError.PermissionDenied -> {}
+  is ChatFileError.RateLimitBreached -> {}
+  is ChatFileError.ReadFailed -> {}
+  is ChatFileError.UploadFailed -> {}
+  else -> {}
+}
 ```
 
 <head>
