Added support for metadata in messages

sdk/communication/azure-communication-chat/CHANGELOG.md

@@ -3,6 +3,7 @@
 ## 1.1.0-beta.1 (Unreleased)
 - Added method `ChatThreadAsyncClient.listParticipants(ListParticipantsOptions listParticipantsOptions)`
 - Added method `ChatThreadAsyncClient.listReadReceipts(ListReadReceiptOptions listReadReceiptOptions)`
+- Added support for metadata in messages.
 
 ## 1.0.1 (2021-05-27)
 - Dependency versions updated.

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/ChatServiceVersion.java

@@ -9,7 +9,7 @@
  * The versions of Chat Service supported by this client library.
  */
 public enum ChatServiceVersion implements ServiceVersion {
-    V2021_03_07("2021-03-07");
+    V2021_04_05_preview6("2021-04-05-preview6");
 
     private final String version;
 
@@ -34,6 +34,6 @@ public String getVersion() {
      */
     public static ChatServiceVersion getLatest() {
 
-        return V2021_03_07;
+        return V2021_04_05_preview6;
     }
 }

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/implementation/AzureCommunicationChatServiceImplBuilder.java

@@ -190,7 +190,7 @@ public AzureCommunicationChatServiceImplBuilder addPolicy(HttpPipelinePolicy cus
      */
     public AzureCommunicationChatServiceImpl buildClient() {
         if (apiVersion == null) {
-            this.apiVersion = "2021-03-07";
+            this.apiVersion = "2021-04-05-preview6";
         }
         if (pipeline == null) {
             this.pipeline = createHttpPipeline();

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/implementation/converters/ChatMessageConverter.java

@@ -26,7 +26,8 @@ public static ChatMessage convert(com.azure.communication.chat.implementation.mo
             .setCreatedOn(obj.getCreatedOn())
             .setDeletedOn(obj.getDeletedOn())
             .setEditedOn(obj.getEditedOn())
-            .setSenderDisplayName(obj.getSenderDisplayName());
+            .setSenderDisplayName(obj.getSenderDisplayName())
+            .setMetadata(obj.getMetadata());
 
         if (obj.getSenderCommunicationIdentifier() != null) {
             chatMessage.setSender(

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/implementation/models/ChatMessage.java

@@ -8,6 +8,7 @@
 import com.azure.core.annotation.Fluent;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.time.OffsetDateTime;
+import java.util.Map;
 
 /** Chat message. */
 @Fluent
@@ -79,6 +80,12 @@ public final class ChatMessage {
     @JsonProperty(value = "editedOn")
     private OffsetDateTime editedOn;
 
+    /*
+     * Message metadata.
+     */
+    @JsonProperty(value = "metadata")
+    private Map<String, String> metadata;
+
     /**
      * Get the id property: The id of the chat message. This id is server generated.
      *
@@ -290,4 +297,24 @@ public ChatMessage setEditedOn(OffsetDateTime editedOn) {
         this.editedOn = editedOn;
         return this;
     }
+
+    /**
+     * Get the metadata property: Message metadata.
+     *
+     * @return the metadata value.
+     */
+    public Map<String, String> getMetadata() {
+        return this.metadata;
+    }
+
+    /**
+     * Set the metadata property: Message metadata.
+     *
+     * @param metadata the metadata value to set.
+     * @return the ChatMessage object itself.
+     */
+    public ChatMessage setMetadata(Map<String, String> metadata) {
+        this.metadata = metadata;
+        return this;
+    }
 }

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/models/ChatMessage.java

@@ -7,6 +7,7 @@
 import com.azure.core.annotation.Fluent;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import java.time.OffsetDateTime;
+import java.util.Map;
 
 /** The ChatMessage model. */
 @Fluent
@@ -73,6 +74,12 @@ public final class ChatMessage {
     @JsonProperty(value = "editedOn")
     private OffsetDateTime editedOn;
 
+    /*
+     * Message metadata.
+     */
+    @JsonProperty(value = "metadata")
+    private Map<String, String> metadata;
+
     /**
      * Get the id property: The id of the chat message. This id is server generated.
      *
@@ -268,4 +275,24 @@ public ChatMessage setEditedOn(OffsetDateTime editedOn) {
         this.editedOn = editedOn;
         return this;
     }
+
+    /**
+     * Get the metadata property: Message metadata.
+     *
+     * @return the metadata value.
+     */
+    public Map<String, String> getMetadata() {
+        return this.metadata;
+    }
+
+    /**
+     * Set the metadata property: Message metadata.
+     *
+     * @param metadata the metadata value to set.
+     * @return the ChatMessage object itself.
+     */
+    public ChatMessage setMetadata(Map<String, String> metadata) {
+        this.metadata = metadata;
+        return this;
+    }
 }

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/models/SendChatMessageOptions.java

@@ -6,6 +6,7 @@
 
 import com.azure.core.annotation.Fluent;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Map;
 
 /** Details of the message to send. */
 @Fluent
@@ -29,6 +30,12 @@ public final class SendChatMessageOptions {
     @JsonProperty(value = "type")
     private ChatMessageType type;
 
+    /*
+     * Message metadata.
+     */
+    @JsonProperty(value = "metadata")
+    private Map<String, String> metadata;
+
     /**
      * Get the content property: Chat message content.
      *
@@ -90,4 +97,24 @@ public SendChatMessageOptions setType(ChatMessageType type) {
         this.type = type;
         return this;
     }
+
+    /**
+     * Get the metadata property: Message metadata.
+     *
+     * @return the metadata value.
+     */
+    public Map<String, String> getMetadata() {
+        return this.metadata;
+    }
+
+    /**
+     * Set the metadata property: Message metadata.
+     *
+     * @param metadata the metadata value to set.
+     * @return the SendChatMessageOptions object itself.
+     */
+    public SendChatMessageOptions setMetadata(Map<String, String> metadata) {
+        this.metadata = metadata;
+        return this;
+    }
 }

sdk/communication/azure-communication-chat/src/main/java/com/azure/communication/chat/models/UpdateChatMessageOptions.java

@@ -6,6 +6,7 @@
 
 import com.azure.core.annotation.Fluent;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Map;
 
 /** Request payload for updating a chat message. */
 @Fluent
@@ -16,6 +17,12 @@ public final class UpdateChatMessageOptions {
     @JsonProperty(value = "content")
     private String content;
 
+    /*
+     * Message metadata.
+     */
+    @JsonProperty(value = "metadata")
+    private Map<String, String> metadata;
+
     /**
      * Get the content property: Chat message content.
      *
@@ -35,4 +42,24 @@ public UpdateChatMessageOptions setContent(String content) {
         this.content = content;
         return this;
     }
+
+    /**
+     * Get the metadata property: Message metadata.
+     *
+     * @return the metadata value.
+     */
+    public Map<String, String> getMetadata() {
+        return this.metadata;
+    }
+
+    /**
+     * Set the metadata property: Message metadata.
+     *
+     * @param metadata the metadata value to set.
+     * @return the UpdateChatMessageOptions object itself.
+     */
+    public UpdateChatMessageOptions setMetadata(Map<String, String> metadata) {
+        this.metadata = metadata;
+        return this;
+    }
 }

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatThreadAsyncClientTest.java

@@ -375,10 +375,7 @@ public Mono<HttpResponse> send(HttpRequest request) {
     public void canSendThenGetHtmlMessage(HttpClient httpClient) {
         // Arrange
         setupTest(httpClient, "canSendThenGetHtmlMessage");
-        SendChatMessageOptions messageRequest = new SendChatMessageOptions()
-            .setType(ChatMessageType.HTML)
-            .setSenderDisplayName("John")
-            .setContent("<div>test</div>");
+        SendChatMessageOptions messageRequest = ChatOptionsProvider.sendMessageOptions(ChatMessageType.HTML, "<div>test</div>");
 
         // Action & Assert
         StepVerifier
@@ -457,6 +454,7 @@ public void canSendThenGetMessage(HttpClient httpClient) {
                 assertEquals(message.getContent().getMessage(), messageRequest.getContent());
                 assertEquals(message.getType(), messageRequest.getType());
                 assertEquals(message.getSenderDisplayName(), messageRequest.getSenderDisplayName());
+                assertTrue(message.getMetadata().equals(messageRequest.getMetadata()));
             })
             .verifyComplete();
     }
@@ -480,6 +478,7 @@ public void canSendThenGetMessageWithResponse(HttpClient httpClient) {
                 ChatMessage message = getResponse.getValue();
                 assertEquals(message.getContent().getMessage(), messageRequest.getContent());
                 assertEquals(message.getSenderDisplayName(), messageRequest.getSenderDisplayName());
+                assertTrue(message.getMetadata().equals(messageRequest.getMetadata()));
             })
             .verifyComplete();
     }
@@ -609,6 +608,7 @@ public void canUpdateExistingMessage(HttpClient httpClient) {
         )
             .assertNext(message -> {
                 assertEquals(message.getContent(), updateMessageRequest.getContent());
+                assertTrue(message.getMetadata().equals(updateMessageRequest.getMetadata()));
             });
 
     }
@@ -659,6 +659,7 @@ public void canUpdateExistingMessageWithResponse(HttpClient httpClient) {
         )
             .assertNext(message -> {
                 assertEquals(message.getContent().getMessage(), updateMessageRequest.getContent());
+                assertTrue(message.getMetadata().equals(updateMessageRequest.getMetadata()));
             })
             .verifyComplete();
     }

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/ChatThreadClientTest.java

@@ -286,6 +286,7 @@ public void canSendThenGetMessage(HttpClient httpClient) {
         ChatMessage message = chatThreadClient.getMessage(response.getId());
         assertEquals(message.getContent().getMessage(), messageRequest.getContent());
         assertEquals(message.getSenderDisplayName(), messageRequest.getSenderDisplayName());
+        assertTrue(message.getMetadata().equals(messageRequest.getMetadata()));
     }
 
     @ParameterizedTest
@@ -301,6 +302,7 @@ public void canSendThenGetMessageWithResponse(HttpClient httpClient) {
         ChatMessage message = chatThreadClient.getMessageWithResponse(response.getId(), Context.NONE).getValue();
         assertEquals(message.getContent().getMessage(), messageRequest.getContent());
         assertEquals(message.getSenderDisplayName(), messageRequest.getSenderDisplayName());
+        assertTrue(message.getMetadata().equals(messageRequest.getMetadata()));
     }
 
     @ParameterizedTest
@@ -344,6 +346,7 @@ public void canUpdateExistingMessage(HttpClient httpClient) {
 
         ChatMessage message = chatThreadClient.getMessage(response.getId());
         assertEquals(message.getContent().getMessage(), updateMessageRequest.getContent());
+        assertTrue(message.getMetadata().equals(updateMessageRequest.getMetadata()));
     }
 
     @ParameterizedTest
@@ -361,6 +364,7 @@ public void canUpdateExistingMessageWithResponse(HttpClient httpClient) {
 
         ChatMessage message = chatThreadClient.getMessage(response.getId());
         assertEquals(message.getContent().getMessage(), updateMessageRequest.getContent());
+        assertTrue(message.getMetadata().equals(updateMessageRequest.getMetadata()));
     }
 
     @ParameterizedTest

sdk/communication/azure-communication-chat/src/test/java/com/azure/communication/chat/implementation/ChatOptionsProvider.java

@@ -42,17 +42,23 @@ public static Iterable<ChatParticipant> addParticipantsOptions(String userId1, S
     }
 
     public static SendChatMessageOptions sendMessageOptions() {
+        return sendMessageOptions(ChatMessageType.TEXT, "Content");
+    }
+
+    public static SendChatMessageOptions sendMessageOptions(ChatMessageType type, String content) {
         SendChatMessageOptions options = new SendChatMessageOptions();
-        options.setContent("Content");
+        options.setContent(content);
         options.setSenderDisplayName("Tester");
-        options.setType(ChatMessageType.TEXT);
+        options.setType(type);
+        options.setMetadata(generateMessageMetadata());
 
         return options;
     }
 
     public static UpdateChatMessageOptions updateMessageOptions() {
         UpdateChatMessageOptions options = new UpdateChatMessageOptions();
         options.setContent("Update Test");
+        options.setMetadata(generateUpdatedMessageMetadata());
 
         return options;
     }
@@ -64,4 +70,22 @@ private static ChatParticipant generateParticipant(String id, String displayName
 
         return chatParticipant;
     }
+
+    private static Map<String, String> generateMessageMetadata() {
+        return new HashMap<String, String>() {{
+            put("deliveryMode", "deliveryMode value");
+            put("onedriveReferences", "onedriveReferences");
+            put("amsreferences", "[\\\"test url file 3\\\"]");
+            put("key", "value key");
+        }};
+    }
+
+    private static Map<String, String> generateUpdatedMessageMetadata() {
+        return new HashMap<String, String>() {{
+            put("deliveryMode", "deliveryMode value - updated");
+            put("onedriveReferences", "onedriveReferences - updated");
+            put("amsreferences", "[\\\"test url file 3\\\"]");
+            put("key", "value key");
+        }};
+    }
 }