Add persistentId field in Message for common attribute

Add persistentId field in Message for common attribute

Author: saipreetham16

README.md

@@ -630,11 +630,12 @@ open class TranscriptItem(
     id: String = "",
     timeStamp: String,
     override var contentType: String,
-    override var serializedContent: String? = null
+    override var serializedContent: String? = null,
+    persistentId: String = ""
 )
 ```
 * `id`
-  * Id for the message. Unique to each message in the transcript.
+  * Id for the message. Unique to each message in the transcript. Id can be used only for the ACPS APIs requests.
   * Type: `String`
 * `timeStamp`
   * Time when the message or event was sent. Formatted in ISO 8601 (e.g. `yyyy-MM-ddThh:mm:ss.SSSZ` or ` 2019-11-08T02:41:28.172Z`)
@@ -645,6 +646,9 @@ open class TranscriptItem(
 * `serializedContent`
   * The raw JSON format of the received WebSocket message
   * Type: Map of `String?`
+* `persistentId`
+  * Id for the message, Unique to each message throughout chat session. This can be used only for tracking purposes by the client.
+  * Type: `String`
 
 --------
 ### TranscriptData

chat-sdk/src/main/java/com/amazon/connect/chat/sdk/model/Message.kt

@@ -31,7 +31,8 @@ data class Message(
     override var displayName: String? = null,
     override var messageDirection: MessageDirection? = null,
     var attachmentId: String? = null,
-    override var metadata: MessageMetadataProtocol? = null
+    override var metadata: MessageMetadataProtocol? = null,
+    override var persistentId: String? = null,
 ) : TranscriptItem(id, timeStamp, contentType, serializedContent), MessageProtocol {
 
     val content: MessageContent?

chat-sdk/src/main/java/com/amazon/connect/chat/sdk/model/TranscriptItem.kt

@@ -8,19 +8,24 @@ interface TranscriptItemProtocol {
     val timeStamp: String
     var contentType: String
     var serializedContent: String?
+    var persistentId: String?
 }
 
 open class TranscriptItem(
     override var id: String,
     override var timeStamp: String,
     override var contentType: String,
-    override var serializedContent: String? = null
+    override var serializedContent: String? = null,
+    override var persistentId: String? = null
 ) : TranscriptItemProtocol {
 
     internal fun updateId(newId: String) {
         this.id = newId
     }
 
+    internal fun updatePersistentId() {
+        this.persistentId = this.id
+    }
     internal fun updateTimeStamp(newTimeStamp: String) {
         this.timeStamp = newTimeStamp
     }

chat-sdk/src/main/java/com/amazon/connect/chat/sdk/repository/ChatService.kt

@@ -395,6 +395,7 @@ class ChatServiceImpl @Inject constructor(
                 // already have that item in our internalTranscript, so we will just apply existing
                 // metadata to new item.
                 if (existingItem is Message && item is Message) {
+                    item.persistentId = existingItem.persistentId
                     if (existingItem.metadata != null && item.metadata == null) {
                         item.metadata = existingItem.metadata
                     }
@@ -432,6 +433,7 @@ class ChatServiceImpl @Inject constructor(
             if (transcriptDict[newId] != null) {
                 transcriptDict.remove(oldId)
                 internalTranscript.removeAll { it.id == oldId }
+                transcriptDict[newId]?.persistentId = oldId
                 // Send out updated transcript
                 coroutineScope.launch {
                     _transcriptListPublisher.emit(TranscriptData(internalTranscript, previousTranscriptNextToken))
@@ -440,6 +442,7 @@ class ChatServiceImpl @Inject constructor(
                 // Update the placeholder message's ID to the new ID
                 (placeholderMessage as TranscriptItem).updateId(newId)
                 placeholderMessage.metadata?.status = MessageStatus.Sent
+                placeholderMessage.persistentId = oldId
                 transcriptDict.remove(oldId)
                 transcriptDict[newId] = placeholderMessage
             }
@@ -457,6 +460,7 @@ class ChatServiceImpl @Inject constructor(
         tempMessage.text = message.text
         tempMessage.contentType = message.contentType
         tempMessage.attachmentId = message.attachmentId
+        tempMessage.updatePersistentId()
         currentDict.remove(tempMessage.id)
         currentDict[message.id] = tempMessage
         handleTranscriptItemUpdate(tempMessage)