Feature/chat preview4 (Communication Identifier changes) (Azure#19404)

* update swagger
* comm identifier changes
* exception constructors
* preview4 updates
* update message types in README.md
* markdown issue
* updated CHANGELOG.md
* PR feedback

Co-authored-by: minnieliu <minnieliu96@hotmail.com>
Co-authored-by: Minnie Liu <peiliu@microsoft.com>

Author: 3 people

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

@@ -1,6 +1,14 @@
 # Release History
 
 ## 1.0.0-beta.5 (Unreleased)
+### Breaking Changes
+
+- ChatMessage - `senderId` renamed to `senderCommunicationIdentifier`, changed type to `CommunicationIdentifier`.
+- ChatMessageReadReceipt - `senderId` renamed to `senderCommunicationIdentifier`, changed type to `CommunicationIdentifier`.
+- ChatParticipant - `user` renamed to `communicationIdentifier`, changed type to `CommunicationIdentifier`.
+- ChatThread - `createdBy` renamed to `createdByCommunicationIdentifier`, changed type to `CommunicationIdentifier`.
+- ChatMessageContent - `initiator` renamed to `initiatorCommunicationIdentifier`, changed type to `CommunicationIdentifier`.
+
 
 ## 1.0.0-beta.4 (2021-02-09)
 ### Breaking Changes

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

@@ -111,11 +111,11 @@ The `ChatThread` object also contains the `getId()` method which retrieves the u
 List<ChatParticipant> participants = new ArrayList<ChatParticipant>();
 
 ChatParticipant firstParticipant = new ChatParticipant()
-    .setUser(user1)
+    .setCommunicationIdentifier(user1)
     .setDisplayName("Participant Display Name 1");
 
 ChatParticipant secondParticipant = new ChatParticipant()
-    .setUser(user2)
+    .setCommunicationIdentifier(user2)
     .setDisplayName("Participant Display Name 2");
 
 participants.add(firstParticipant);
@@ -232,13 +232,15 @@ The original time of message creation can be accessed using `chatMessage.getCrea
 
 listMessages returns different types of messages which can be identified by `chatMessage.getType()`. These types are:
 
--`Text`: Regular chat message sent by a thread member.
+- `text`: Regular chat message sent by a thread participant.
 
--`ThreadActivity/TopicUpdate`: System message that indicates the topic has been updated.
+- `html`: HTML chat message sent by a thread participant.
 
--`ThreadActivity/AddMember`: System message that indicates one or more participants have been added to the chat thread.
+- `topicUpdated`: System message that indicates the topic has been updated.
 
--`ThreadActivity/DeleteMember`: System message that indicates a participant has been removed from the chat thread.
+- `participantAdded`: System message that indicates one or more participants have been added to the chat thread.
+
+- `participantRemoved`: System message that indicates a participant has been removed from the chat thread.
 
 For more details, see [Message Types](https://docs.microsoft.com/azure/communication-services/concepts/chat/concepts#message-types).
 
@@ -270,7 +272,7 @@ String chatMessageId = "Id";
 chatThreadClient.deleteMessage(chatMessageId);
 ```
 
-### Chat Thread Member Operations
+### Chat Thread Participant Operations
 
 #### List chat participants
 
@@ -283,7 +285,7 @@ chatParticipantsResponse.iterableByPage().forEach(resp -> {
     System.out.printf("Response headers are %s. Url %s  and status code %d %n", resp.getHeaders(),
         resp.getRequest().getUrl(), resp.getStatusCode());
     resp.getItems().forEach(chatParticipant -> {
-        System.out.printf("Participant id is %s.", chatParticipant.getUser().getId());
+        System.out.printf("Participant id is %s.", ((CommunicationUserIdentifier) chatParticipant.getCommunicationIdentifier()).getId());
     });
 });
 ```
@@ -293,7 +295,7 @@ chatParticipantsResponse.iterableByPage().forEach(resp -> {
 Use `addParticipants` method to add participants to the thread identified by threadId.
 `addChatParticipantsOptions` describes the request object containing the members to be added; Use `.setParticipants()` to set the participants to be added to the thread;
 
-- `user`, required, is the CommunicationUser you've created by using the CommunicationIdentityClient. More info at: [Create A User](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-java#create-a-user).
+- `communicationIdentifier`, required, is the CommunicationIdentifier you've created by using the CommunicationIdentityClient. More info at: [Create A User](https://docs.microsoft.com/azure/communication-services/quickstarts/access-tokens?pivots=programming-language-java#create-a-user).
 - `display_name`, optional, is the display name for the thread member.
 - `share_history_time`, optional, is the time from which the chat history is shared with the member. To share history since the inception of the chat thread, set this property to any date equal to, or less than the thread creation time. To share no history previous to when the member was added, set it to the current date. To share partial history, set it to the required date.
 
@@ -302,11 +304,11 @@ Use `addParticipants` method to add participants to the thread identified by thr
 List<ChatParticipant> participants = new ArrayList<ChatParticipant>();
 
 ChatParticipant firstParticipant = new ChatParticipant()
-    .setUser(user1)
+    .setCommunicationIdentifier(user1)
     .setDisplayName("Display Name 1");
 
 ChatParticipant secondParticipant = new ChatParticipant()
-    .setUser(user2)
+    .setCommunicationIdentifier(user2)
     .setDisplayName("Display Name 2");
 
 participants.add(firstParticipant);
@@ -320,7 +322,7 @@ chatThreadClient.addParticipants(addChatParticipantsOptions);
 #### Remove participant
 
 Use `removeParticipant` method to remove a participant from the chat thread identified by chatThreadId.
-`user` is the CommunicationUser you've created.
+`identifier` is the CommunicationIdentifier you've created.
 
 <!-- embedme ./src/samples/java/com/azure/communication/chat/ReadmeSamples.java#L251-L251 -->
 ```Java

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

@@ -11,6 +11,7 @@
 import com.azure.communication.chat.implementation.converters.ChatMessageConverter;
 import com.azure.communication.chat.implementation.converters.ChatParticipantConverter;
 import com.azure.communication.chat.implementation.converters.ChatMessageReadReceiptConverter;
+import com.azure.communication.chat.implementation.converters.CommunicationIdentifierConverter;
 import com.azure.communication.chat.implementation.converters.SendChatMessageResultConverter;
 import com.azure.communication.chat.implementation.models.SendReadReceiptRequest;
 import com.azure.communication.chat.models.AddChatParticipantsOptions;
@@ -24,7 +25,7 @@
 import com.azure.communication.chat.models.SendChatMessageOptions;
 import com.azure.communication.chat.models.UpdateChatMessageOptions;
 import com.azure.communication.chat.models.UpdateChatThreadOptions;
-import com.azure.communication.common.CommunicationUserIdentifier;
+import com.azure.communication.common.CommunicationIdentifier;
 import com.azure.core.annotation.ReturnType;
 import com.azure.core.annotation.ServiceClient;
 import com.azure.core.annotation.ServiceMethod;
@@ -219,15 +220,15 @@ Mono<Response<AddChatParticipantsResult>> addParticipants(AddChatParticipantsOpt
     /**
      * Remove a participant from a thread.
      *
-     * @param user User identity of the participant to remove from the thread.
+     * @param identifier Identity of the participant to remove from the thread.
      * @return the completion.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Void> removeParticipant(CommunicationUserIdentifier user) {
+    public Mono<Void> removeParticipant(CommunicationIdentifier identifier) {
         try {
-            Objects.requireNonNull(user, "'user' cannot be null.");
-            Objects.requireNonNull(user.getId(), "'user.getId()' cannot be null.");
-            return withContext(context -> removeParticipant(user, context)
+            Objects.requireNonNull(identifier, "'identifier' cannot be null.");
+
+            return withContext(context -> removeParticipant(identifier, context)
                 .flatMap((Response<Void> res) -> {
                     return Mono.empty();
                 }));
@@ -240,15 +241,15 @@ public Mono<Void> removeParticipant(CommunicationUserIdentifier user) {
     /**
      * Remove a participant from a thread.
      *
-     * @param user User identity of the participant to remove from the thread.
+     * @param identifier Identity of the participant to remove from the thread.
      * @return the completion.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<Response<Void>> removeParticipantWithResponse(CommunicationUserIdentifier user) {
+    public Mono<Response<Void>> removeParticipantWithResponse(CommunicationIdentifier identifier) {
         try {
-            Objects.requireNonNull(user, "'user' cannot be null.");
-            Objects.requireNonNull(user.getId(), "'user.getId()' cannot be null.");
-            return withContext(context -> removeParticipant(user, context));
+            Objects.requireNonNull(identifier, "'identifier' cannot be null.");
+
+            return withContext(context -> removeParticipant(identifier, context));
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
         }
@@ -257,14 +258,15 @@ public Mono<Response<Void>> removeParticipantWithResponse(CommunicationUserIdent
     /**
      * Remove a participant from a thread.
      *
-     * @param user User identity of the participant to remove from the thread.
+     * @param identifier Identity of the participant to remove from the thread.
      * @param context The context to associate with this operation.
      * @return the completion.
      */
-    Mono<Response<Void>> removeParticipant(CommunicationUserIdentifier user, Context context) {
+    Mono<Response<Void>> removeParticipant(CommunicationIdentifier identifier, Context context) {
         context = context == null ? Context.NONE : context;
 
-        return this.chatThreadClient.removeChatParticipantWithResponseAsync(chatThreadId, user.getId(), context);
+        return this.chatThreadClient.removeChatParticipantWithResponseAsync(
+            chatThreadId, CommunicationIdentifierConverter.convert(identifier), context);
     }
 
     /**

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

@@ -12,7 +12,7 @@
 import com.azure.communication.chat.models.ListReadReceiptOptions;
 import com.azure.communication.chat.models.SendChatMessageOptions;
 import com.azure.communication.chat.models.UpdateChatMessageOptions;
-import com.azure.communication.common.CommunicationUserIdentifier;
+import com.azure.communication.common.CommunicationIdentifier;
 import com.azure.core.annotation.ReturnType;
 import com.azure.core.annotation.ServiceClient;
 import com.azure.core.annotation.ServiceMethod;
@@ -132,25 +132,25 @@ public Response<AddChatParticipantsResult> addParticipantWithResponse(ChatPartic
     /**
      * Remove a participant from a thread.
      *
-     * @param user User identity of the participant to remove from the thread.
+     * @param identifier Identity of the participant to remove from the thread.
      * @param context The context to associate with this operation.
      * @return the completion.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Response<Void> removeParticipantWithResponse(CommunicationUserIdentifier user, Context context) {
+    public Response<Void> removeParticipantWithResponse(CommunicationIdentifier identifier, Context context) {
 
-        return this.client.removeParticipant(user, context).block();
+        return this.client.removeParticipant(identifier, context).block();
     }
 
     /**
      * Remove a participant from a thread.
      *
-     * @param user User identity of the thread participant to remove from the thread.
+     * @param identifier Identity of the thread participant to remove from the thread.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public void removeParticipant(CommunicationUserIdentifier user) {
+    public void removeParticipant(CommunicationIdentifier identifier) {
 
-        this.client.removeParticipant(user).block();
+        this.client.removeParticipant(identifier).block();
     }
 
     /**

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

@@ -121,7 +121,7 @@ public ChatImpl getChatClient() {
         this.httpPipeline = httpPipeline;
         this.serializerAdapter = serializerAdapter;
         this.endpoint = endpoint;
-        this.apiVersion = "2020-11-01-preview3";
+        this.apiVersion = "2021-01-27-preview4";
         this.chatThreadClient = new ChatThreadImpl(this);
         this.chatClient = new ChatImpl(this);
     }