Add TypingNotification options for setting SenderDisplayName

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

@@ -4,6 +4,7 @@
 - Added method `ChatThreadAsyncClient.listParticipants(ListParticipantsOptions listParticipantsOptions)`
 - Added method `ChatThreadAsyncClient.listReadReceipts(ListReadReceiptOptions listReadReceiptOptions)`
 - Added support for metadata in messages.
+- Added options class `SendTypingNotificationOptions` for setting `SenderDisplayName` of the notification sender.
 
 ## 1.0.1 (2021-05-27)
 - Dependency versions updated.

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

@@ -353,10 +353,15 @@ readReceiptsResponse.iterableByPage().forEach(resp -> {
 #### Send typing notification
 
 Use `sendTypingNotification` method to post a typing notification event to a chat thread, on behalf of a user.
+`typingNotificationOptions` is used to describe the typing notification request.
 
-<!-- embedme ./src/samples/java/com/azure/communication/chat/ReadmeSamples.java#L275-L275 -->
+- Use `senderDisplayName` to set the display name of the notification sender;
+
+<!-- embedme ./src/samples/java/com/azure/communication/chat/ReadmeSamples.java#L276-L278 -->
 ```Java
-chatThreadClient.sendTypingNotification();
+TypingNotificationOptions options = new TypingNotificationOptions();
+options.setSenderDisplayName("Sender Display Name");
+chatThreadClient.sendTypingNotification(options);
 ```
 
 

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

@@ -31,6 +31,7 @@
 import com.azure.communication.chat.models.ListReadReceiptOptions;
 import com.azure.communication.chat.models.SendChatMessageOptions;
 import com.azure.communication.chat.models.SendChatMessageResult;
+import com.azure.communication.chat.models.TypingNotificationOptions;
 import com.azure.communication.chat.models.UpdateChatMessageOptions;
 import com.azure.communication.chat.models.UpdateChatThreadOptions;
 import com.azure.communication.common.CommunicationIdentifier;
@@ -734,7 +735,8 @@ Mono<Response<Void>> deleteMessage(String chatMessageId, Context context) {
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Void> sendTypingNotification() {
         try {
-            return withContext(context -> sendTypingNotification(context)
+            TypingNotificationOptions options = new TypingNotificationOptions();
+            return withContext(context -> sendTypingNotification(options, context)
                 .flatMap((Response<Void> res) -> {
                     return Mono.empty();
                 }));
@@ -753,7 +755,8 @@ public Mono<Void> sendTypingNotification() {
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<Response<Void>> sendTypingNotificationWithResponse() {
         try {
-            return withContext(context -> sendTypingNotification(context));
+            TypingNotificationOptions options = new TypingNotificationOptions();
+            return withContext(context -> sendTypingNotification(options, context));
         } catch (RuntimeException ex) {
             return monoError(logger, ex);
         }
@@ -762,13 +765,54 @@ public Mono<Response<Void>> sendTypingNotificationWithResponse() {
     /**
      * Posts a typing event to a thread, on behalf of a user.
      *
+     * @param options Options for sending the typing notification.
+     * @throws ChatErrorResponseException 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.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<Void> sendTypingNotification(TypingNotificationOptions options) {
+        try {
+            Objects.requireNonNull(options, "'options' cannot be null.");
+            return withContext(context -> sendTypingNotification(options, context)
+                .flatMap((Response<Void> res) -> {
+                    return Mono.empty();
+                }));
+        } catch (RuntimeException ex) {
+            return monoError(logger, ex);
+        }
+    }
+
+    /**
+     * Posts a typing event to a thread, on behalf of a user.
+     *
+     * @param options Options for sending the typing notification.
+     * @throws ChatErrorResponseException 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.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Mono<Response<Void>> sendTypingNotificationWithResponse(TypingNotificationOptions options) {
+        try {
+            Objects.requireNonNull(options, "'options' cannot be null.");
+            return withContext(context -> sendTypingNotification(options, context));
+        } catch (RuntimeException ex) {
+            return monoError(logger, ex);
+        }
+    }
+
+    /**
+     * Posts a typing event to a thread, on behalf of a user.
+     *
+     * @param options Options for sending the typing notification.
      * @param context The context to associate with this operation.
      * @return the completion.
      */
-    Mono<Response<Void>> sendTypingNotification(Context context) {
+    Mono<Response<Void>> sendTypingNotification(TypingNotificationOptions options, Context context) {
         context = context == null ? Context.NONE : context;
         try {
-            return this.chatThreadClient.sendTypingNotificationWithResponseAsync(chatThreadId, context)
+            Objects.requireNonNull(options, "'options' cannot be null.");
+            return this.chatThreadClient.sendTypingNotificationWithResponseAsync(chatThreadId, options, context)
                 .onErrorMap(CommunicationErrorResponseException.class, e -> translateException(e));
         } catch (RuntimeException ex) {
             return monoError(logger, ex);

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

@@ -14,6 +14,7 @@
 import com.azure.communication.chat.models.ListReadReceiptOptions;
 import com.azure.communication.chat.models.SendChatMessageOptions;
 import com.azure.communication.chat.models.SendChatMessageResult;
+import com.azure.communication.chat.models.TypingNotificationOptions;
 import com.azure.communication.chat.models.UpdateChatMessageOptions;
 import com.azure.communication.common.CommunicationIdentifier;
 import com.azure.core.annotation.ReturnType;
@@ -350,8 +351,8 @@ public void deleteMessage(String chatMessageId) {
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
     public Response<Void> sendTypingNotificationWithResponse(Context context) {
-
-        return this.client.sendTypingNotification(context).block();
+        TypingNotificationOptions options = new TypingNotificationOptions();
+        return this.client.sendTypingNotification(options, context).block();
     }
 
     /**
@@ -365,6 +366,32 @@ public void sendTypingNotification() {
         this.client.sendTypingNotification().block();
     }
 
+    /**
+     * Posts a typing event to a thread, on behalf of a user.
+     *
+     * @param options Options for sending the typing notification.
+     * @param context The context to associate with this operation.
+     * @throws ChatErrorResponseException 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.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public Response<Void> sendTypingNotificationWithResponse(TypingNotificationOptions options, Context context) {
+        return this.client.sendTypingNotification(options, context).block();
+    }
+
+    /**
+     * Posts a typing event to a thread, on behalf of a user.
+     *
+     * @param options Options for sending the typing notification.
+     * @throws ChatErrorResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
+     */
+    @ServiceMethod(returns = ReturnType.SINGLE)
+    public void sendTypingNotification(TypingNotificationOptions options) {
+        this.client.sendTypingNotification(options).block();
+    }
+
     /**
      * Posts a read receipt event to a thread, on behalf of a user.
      *