Update readme, changelog, add back some previous changes

Add SendChatMessageResult converting to messageId changes back 
Add renaming updateChatThread to updateTopic back
Add renaming UpdateChatThreadRequest to UpdateTopicRequest back
Update README
Update CHANGELOG

Co-authored-by: Marc Ma <[email protected]>

Author: marche0133

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

@@ -11,9 +11,19 @@
 
 ### Breaking Changes
 - Chat client is split into chatClient and chatThreadClient
-- Rename member and threadMember to participant
 - Add participants API changed with a /:add at the end
 - Remove priority in message
+- Change request and response types to more specific types
+- listChatParticipantsPages takes two more parameters: maxPageSize and skip
+- listChatReadReceiptsPages takes two more parameters: maxPageSize and skip
+
+### Renamed
+- Rename retrieveNextThreadPages to listChatThreadsNext
+- Rename retrieveNextThreadPages to listChatThreadsNext
+- Rename retrieveNextMessagePages to listChatMessagesNext
+- Rename retrieveNextParticipantsPages to listChatParticipantsNext
+- Rename retrieveNextReceiptsPages to listChatReadReceiptsNext
+
 
 
 ## 1.0.0-beta.4 (Skipped)
@@ -33,6 +43,12 @@
 - All OffsetDateTime properties are now in RFC3339 format instead of ISO8601 format
 
 ## 1.0.0-beta.3 (Skipped)
+### Breaking Changes
+- Return messageId instead of SendChatMessageResult
+- Rename ReadReceipt to ChatMessageReadReceipt
+- Rename updateChatThread to updateTopic
+- Rename UpdateChatThreadRequest to UpdateTopicRequest
+- Rename member and threadMember to participant
 
 ## 1.0.0-beta.2 (2020-10-06)
 This is the initial release of Azure Communication Services for chat. For more information, please see the [README][read_me] and [documentation][documentation].

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

@@ -145,8 +145,11 @@ CreateChatThreadRequest thread = new CreateChatThreadRequest()
     .setTopic(topic)
     .setParticipants(participants);
 
-client.createChatThread(thread, new Callback<MultiStatusResponse>() {
-    public void onSuccess(MultiStatusResponse result, okhttp3.Response response) {
+// optional, set a repeat request ID 
+final String repeatabilityRequestID = '123';
+
+client.createChatThread(thread, repeatabilityRequestID, new Callback<CreateChatThreadResult>() {
+    public void onSuccess(CreateChatThreadResult result, okhttp3.Response response) {
         // MultiStatusResponse is the result returned from creating a thread.
         // It has a 'multipleStatus' property which represents a list of IndividualStatusResponse.
         String threadId;
@@ -225,9 +228,8 @@ client.listChatThreadsPages(maxPageSize, startTime,
     }
 });
 
-void retrieveNextThreadPages(String nextPageId,
-    AsyncPagedDataCollection<ChatThreadInfo, Page<ChatThreadInfo>> pageCollection) {
-    pageCollection.getPage(nextPageId, new Callback<Page<ChatThreadInfo>>() {
+void listChatThreadsNext(String nextLink,
+    AsyncPagedDataCollection<Page<ChatThreadInfo>> pageCollection) {
         @Override
         public void onSuccess(Page<ChatThreadInfo> nextPage, Response response) {
             for (ChatThreadInfo thread : nextPage.getItems()) {
@@ -242,7 +244,6 @@ void retrieveNextThreadPages(String nextPageId,
         public void onFailure(Throwable throwable, Response response) {
             // Handle error.
         }
-    });
 }
 ```
 
@@ -309,7 +310,7 @@ SendChatMessageRequest message = new SendChatMessageRequest()
 
 // The unique ID of the thread.
 final String threadId = "<thread_id>";
-client.sendChatMessage(threadId, message, new Callback<SendChatMessageResult>() {
+client.sendChatMessage(threadId, message, new Callback<String>() {
     @Override
     public void onSuccess(String messageId, Response response) {
         // A string is the response returned from sending a message, it is an id, 
@@ -392,9 +393,8 @@ client.listChatMessagesPages(threadId,
         }
 });
 
-void retrieveNextMessagePages(String nextPageId,
-    AsyncPagedDataCollection<ChatMessage, Page<ChatMessage>> pageCollection) {
-    pageCollection.getPage(nextPageId, new Callback<Page<ChatMessage>>() {
+void listChatMessagesNext(String nextLink,
+    AsyncPagedDataCollection<Page<ChatMessage>> pageCollection) {
         @Override
         public void onSuccess(Page<ChatMessage> nextPage, Response response) {
             for (ChatMessage thread : nextPage.getItems()) {
@@ -409,7 +409,6 @@ void retrieveNextMessagePages(String nextPageId,
         public void onFailure(Throwable throwable, Response response) {
             // Handle error.
         }
-    });
 }
 ```
 
@@ -472,7 +471,16 @@ Use the `listChatParticipants` method to retrieve the participants participating
 ```java
 // The unique ID of the thread.
 final String threadId = "<thread_id>";
+
+// The maximum number of participants to be returned per page, optional.
+final int maxPageSize = 10;
+
+// Skips participants up to a specified position in response.
+final int skip = 0;
+
 client.listChatParticipantsPages(threadId,
+    maxPageSize,
+    skip,
     new Callback<AsyncPagedDataCollection<ChatParticipant, Page<ChatParticipant>>>() {
     @Override
     public void onSuccess(AsyncPagedDataCollection<ChatParticipant, Page<ChatParticipant>> firstPage,
@@ -500,9 +508,8 @@ client.listChatParticipantsPages(threadId,
     }
 });
 
-void retrieveNextParticipantsPages(String nextPageId,
-    AsyncPagedDataCollection<ChatParticipant, Page<ChatParticipant>> pageCollection) {
-    pageCollection.getPage(nextPageId, new Callback<Page<ChatParticipant>>() {
+void listChatParticipantsNext(String nextLink,
+    AsyncPagedDataCollection<Page<ChatParticipant>> pageCollection) {
         @Override
         public void onSuccess(Page<ChatParticipant> nextPage, Response response) {
             for (ChatParticipant participant : nextPage.getItems()) {
@@ -517,7 +524,6 @@ void retrieveNextParticipantsPages(String nextPageId,
         public void onFailure(Throwable throwable, Response response) {
             // Handle error.
         }
-    });
 }
 ```
 
@@ -629,15 +635,24 @@ Use the `listChatReadReceipts` method to retrieve read receipts for a thread.
 ```java
 // The unique ID of the thread.
 final String threadId = "<thread_id>";
+
+// The maximum number of participants to be returned per page, optional.
+final int maxPageSize = 10;
+
+// Skips participants up to a specified position in response.
+final int skip = 0;
+
 client.listChatReadReceiptsPages(threadId,
-    new Callback<AsyncPagedDataCollection<ReadReceipt, Page<ReadReceipt>>>() {
+    maxPageSize,
+    skip,
+    new Callback<AsyncPagedDataCollection<ChatMessageReadReceipt, Page<ChatMessageReadReceipt>>>() {
     @Override
-    public void onSuccess(AsyncPagedDataCollection<ReadReceipt, Page<ReadReceipt>> result,
+    public void onSuccess(AsyncPagedDataCollection<ChatMessageReadReceipt, Page<ChatMessageReadReceipt>> result,
         Response response) {
         // pageCollection enables enumerating list of chat participants.
-        pageCollection.getFirstPage(new Callback<Page<ReadReceipt>>() {
+        pageCollection.getFirstPage(new Callback<Page<ChatMessageReadReceipt>>() {
             @Override
-            public void onSuccess(Page<ReadReceipt> firstPage, Response response) {
+            public void onSuccess(Page<ChatMessageReadReceipt> firstPage, Response response) {
                 for (ReadReceipt receipt : firstPage.getItems()) {
                     // Take further action.
                 }
@@ -657,11 +672,10 @@ client.listChatReadReceiptsPages(threadId,
     }
 });
 
-void retrieveNextReceiptsPages(String nextPageId,
-    AsyncPagedDataCollection<ReadReceipt, Page<ReadReceipt>> pageCollection) {
-    pageCollection.getPage(nextPageId, new Callback<Page<ReadReceipt>>() {
+void listChatReadReceiptsNext(String nextLink,
+    AsyncPagedDataCollection<Page<ChatMessageReadReceipt>> pageCollection) {
         @Override
-        public void onSuccess(Page<ReadReceipt> nextPage, Response response) {
+        public void onSuccess(Page<ChatMessageReadReceipt> nextPage, Response response) {
             for (ReadReceipt receipt : nextPage.getItems()) {
                 // Take further action.
             }
@@ -674,7 +688,6 @@ void retrieveNextReceiptsPages(String nextPageId,
         public void onFailure(Throwable throwable, Response response) {
             // Handle error.
         }
-    });
 }
 ```
 
@@ -683,7 +696,7 @@ void retrieveNextReceiptsPages(String nextPageId,
 When an error occurs, the client calls the callback's `onFailure` method. You can use the provided `Throwable` to act upon the failure.
 
 ```java
-client.createChatThread(thread, new Callback<MultiStatusResponse>() {
+client.createChatThread(thread, new Callback<CreateChatThreadResult>() {
     public void onFailure(Throwable throwable, okhttp3.Response response) {
         // Handle error.
     }

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

@@ -10,40 +10,21 @@
 import com.azure.android.communication.chat.models.AddChatParticipantsResult;
 import com.azure.android.communication.chat.models.ChatMessage;
 import com.azure.android.communication.chat.models.ChatMessageReadReceipt;
-import com.azure.android.communication.chat.models.ChatMessageReadReceiptsCollection;
-import com.azure.android.communication.chat.models.ChatMessagesCollection;
 import com.azure.android.communication.chat.models.ChatParticipant;
-import com.azure.android.communication.chat.models.ChatParticipantsCollection;
 import com.azure.android.communication.chat.models.CommunicationErrorResponseException;
 import com.azure.android.communication.chat.models.SendChatMessageRequest;
 import com.azure.android.communication.chat.models.SendChatMessageResult;
 import com.azure.android.communication.chat.models.SendReadReceiptRequest;
 import com.azure.android.communication.chat.models.UpdateChatMessageRequest;
-import com.azure.android.communication.chat.models.UpdateChatThreadRequest;
+import com.azure.android.communication.chat.models.UpdateTopicRequest;
 import com.azure.android.core.http.Callback;
-import com.azure.android.core.http.Response;
 import com.azure.android.core.http.ServiceClient;
-import com.azure.android.core.http.exception.HttpResponseException;
 import com.azure.android.core.http.responsepaging.AsyncPagedDataCollection;
-import com.azure.android.core.http.responsepaging.AsyncPagedDataRetriever;
-import com.azure.android.core.http.responsepaging.PagedDataResponseCollection;
-import com.azure.android.core.http.responsepaging.PagedDataResponseRetriever;
 import com.azure.android.core.util.paging.Page;
-import com.azure.android.core.util.paging.PagedDataCollection;
-import com.azure.android.core.util.paging.PagedDataRetriever;
+
 import okhttp3.Interceptor;
-import okhttp3.RequestBody;
-import okhttp3.ResponseBody;
+
 import org.threeten.bp.OffsetDateTime;
-import retrofit2.Call;
-import retrofit2.http.Body;
-import retrofit2.http.DELETE;
-import retrofit2.http.GET;
-import retrofit2.http.Header;
-import retrofit2.http.PATCH;
-import retrofit2.http.Path;
-import retrofit2.http.POST;
-import retrofit2.http.Query;
 
 /**
  * Initializes a new instance of the asynchronous AzureCommunicationChatService type.
@@ -125,8 +106,23 @@ public void sendChatReadReceipt(String chatThreadId, SendReadReceiptRequest send
      * @throws CommunicationErrorResponseException thrown if the request is rejected by server.
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      */
-    public void sendChatMessage(String chatThreadId, SendChatMessageRequest sendChatMessageRequest, final Callback<SendChatMessageResult> callback) {
-        this.serviceClient.sendChatMessage(chatThreadId, sendChatMessageRequest, callback);
+    public void sendChatMessage(String chatThreadId, SendChatMessageRequest sendChatMessageRequest, final Callback<String> callback) {
+        Callback<SendChatMessageResult> proxyCallback = new Callback<SendChatMessageResult>() {
+            @Override
+            public void onSuccess(SendChatMessageResult result, okhttp3.Response response) {
+                if (result == null) {
+                    callback.onSuccess(null, response);
+                } else {
+                    callback.onSuccess(result.getId(), response);
+                }
+            }
+
+            @Override
+            public void onFailure(Throwable throwable, okhttp3.Response response) {
+                callback.onFailure(throwable, response);
+            }
+        };
+        this.serviceClient.sendChatMessage(chatThreadId, sendChatMessageRequest, proxyCallback);
     }
 
     /**
@@ -303,14 +299,14 @@ public void addChatParticipants(String chatThreadId, AddChatParticipantsRequest
      * Updates a thread's properties.
      *
      * @param chatThreadId The id of the thread to update.
-     * @param updateChatThreadRequest Request payload for updating a chat thread.
+     * @param updateTopicRequest Request payload for updating a chat thread.
      * @param callback the Callback that receives the response.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws CommunicationErrorResponseException thrown if the request is rejected by server.
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      */
-    public void updateChatThread(String chatThreadId, UpdateChatThreadRequest updateChatThreadRequest, final Callback<Void> callback) {
-        this.serviceClient.updateChatThread(chatThreadId, updateChatThreadRequest, callback);
+    public void updateTopic(String chatThreadId, UpdateTopicRequest updateTopicRequest, final Callback<Void> callback) {
+        this.serviceClient.updateChatThread(chatThreadId, updateTopicRequest, callback);
     }
 
     /**

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

@@ -10,40 +10,22 @@
 import com.azure.android.communication.chat.models.AddChatParticipantsResult;
 import com.azure.android.communication.chat.models.ChatMessage;
 import com.azure.android.communication.chat.models.ChatMessageReadReceipt;
-import com.azure.android.communication.chat.models.ChatMessageReadReceiptsCollection;
-import com.azure.android.communication.chat.models.ChatMessagesCollection;
 import com.azure.android.communication.chat.models.ChatParticipant;
-import com.azure.android.communication.chat.models.ChatParticipantsCollection;
 import com.azure.android.communication.chat.models.CommunicationErrorResponseException;
 import com.azure.android.communication.chat.models.SendChatMessageRequest;
 import com.azure.android.communication.chat.models.SendChatMessageResult;
 import com.azure.android.communication.chat.models.SendReadReceiptRequest;
 import com.azure.android.communication.chat.models.UpdateChatMessageRequest;
-import com.azure.android.communication.chat.models.UpdateChatThreadRequest;
-import com.azure.android.core.http.Callback;
+import com.azure.android.communication.chat.models.UpdateTopicRequest;
 import com.azure.android.core.http.Response;
 import com.azure.android.core.http.ServiceClient;
-import com.azure.android.core.http.exception.HttpResponseException;
-import com.azure.android.core.http.responsepaging.AsyncPagedDataCollection;
-import com.azure.android.core.http.responsepaging.AsyncPagedDataRetriever;
 import com.azure.android.core.http.responsepaging.PagedDataResponseCollection;
-import com.azure.android.core.http.responsepaging.PagedDataResponseRetriever;
 import com.azure.android.core.util.paging.Page;
 import com.azure.android.core.util.paging.PagedDataCollection;
-import com.azure.android.core.util.paging.PagedDataRetriever;
+
 import okhttp3.Interceptor;
-import okhttp3.RequestBody;
-import okhttp3.ResponseBody;
+
 import org.threeten.bp.OffsetDateTime;
-import retrofit2.Call;
-import retrofit2.http.Body;
-import retrofit2.http.DELETE;
-import retrofit2.http.GET;
-import retrofit2.http.Header;
-import retrofit2.http.PATCH;
-import retrofit2.http.Path;
-import retrofit2.http.POST;
-import retrofit2.http.Query;
 
 /**
  * Initializes a new instance of the synchronous AzureCommunicationChatService type.
@@ -140,8 +122,11 @@ public Response<Void> sendChatReadReceiptWithRestResponse(String chatThreadId, S
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return result of the send message operation.
      */
-    public Response<SendChatMessageResult> sendChatMessageWithRestResponse(String chatThreadId, SendChatMessageRequest sendChatMessageRequest) {
-        return this.serviceClient.sendChatMessageWithRestResponse(chatThreadId, sendChatMessageRequest);
+    public Response<String> sendChatMessageWithRestResponse(String chatThreadId, SendChatMessageRequest sendChatMessageRequest) {
+        Response<SendChatMessageResult> sendResult = this.serviceClient.sendChatMessageWithRestResponse(chatThreadId, sendChatMessageRequest);
+        if (sendResult.getValue() == null)
+            return new Response<String>(null, sendResult.getStatusCode(), sendResult.getHeaders(), null);
+        return new Response<String>(null, sendResult.getStatusCode(), sendResult.getHeaders(), sendResult.getValue().getId());
     }
 
     /**
@@ -348,14 +333,14 @@ public Response<AddChatParticipantsResult> addChatParticipantsWithRestResponse(S
      * Updates a thread's properties.
      *
      * @param chatThreadId The id of the thread to update.
-     * @param updateChatThreadRequest Request payload for updating a chat thread.
+     * @param updateTopicRequest Request payload for updating a chat thread.
      * @throws IllegalArgumentException thrown if parameters fail the validation.
      * @throws CommunicationErrorResponseException thrown if the request is rejected by server.
      * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the completion.
      */
-    public Response<Void> updateChatThreadWithRestResponse(String chatThreadId, UpdateChatThreadRequest updateChatThreadRequest) {
-        return this.serviceClient.updateChatThreadWithRestResponse(chatThreadId, updateChatThreadRequest);
+    public Response<Void> updateTopicWithRestResponse(String chatThreadId, UpdateTopicRequest updateTopicRequest) {
+        return this.serviceClient.updateChatThreadWithRestResponse(chatThreadId, updateTopicRequest);
     }
 
     /**