add exceptions to javadoc

Azure · Mar 19, 2021 · c774f75 · c774f75
1 parent fc5302e
commit c774f75
Show file tree

Hide file tree

Showing 4 changed files with 149 additions and 3 deletions.
diff --git a/.../azure-communication-chat/src/main/java/com/azure/communication/chat/ChatAsyncClient.java b/.../azure-communication-chat/src/main/java/com/azure/communication/chat/ChatAsyncClient.java
@@ -59,6 +59,8 @@ public ChatThreadAsyncClient getChatThreadClient(String chatThreadId) {
      * Creates a chat thread.
      *
      * @param options Options for creating a chat thread.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the response.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
@@ -83,6 +85,8 @@ public Mono<CreateChatThreadResult> createChatThread(CreateChatThreadOptions opt
      * Creates a chat thread.
      *
      * @param options Options for creating a chat thread.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the response.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
@@ -100,6 +104,8 @@ public Mono<Response<CreateChatThreadResult>> createChatThreadWithResponse(Creat
      *
      * @param options Options for creating a chat thread.
      * @param context The context to associate with this operation.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the response.
      */
     Mono<Response<CreateChatThreadResult>> createChatThread(CreateChatThreadOptions options, Context context) {
@@ -118,6 +124,8 @@ Mono<Response<CreateChatThreadResult>> createChatThread(CreateChatThreadOptions
     /**
      * Gets the list of chat threads of a user.
      *
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the paged list of chat threads of a user.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
@@ -140,6 +148,8 @@ public PagedFlux<ChatThreadItem> listChatThreads() {
      * Gets the list of chat threads of a user.
      *
      * @param listThreadsOptions The request options.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the paged list of chat threads of a user.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
@@ -181,6 +191,8 @@ PagedFlux<ChatThreadItem> listChatThreads(ListChatThreadsOptions listThreadsOpti
      * Deletes a chat thread.
      *
      * @param chatThreadId Chat thread id to delete.
+     * @throws HttpResponseException 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)
@@ -200,6 +212,8 @@ public Mono<Void> deleteChatThread(String chatThreadId) {
      * Deletes a chat thread.
      *
      * @param chatThreadId Chat thread id to delete.
+     * @throws HttpResponseException 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)
@@ -217,6 +231,8 @@ public Mono<Response<Void>> deleteChatThreadWithResponse(String chatThreadId) {
      *
      * @param chatThreadId Chat thread id to delete.
      * @param context The context to associate with this operation.
+     * @throws HttpResponseException 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.
      */
     Mono<Response<Void>> deleteChatThread(String chatThreadId, Context context) {

diff --git a/...ation/azure-communication-chat/src/main/java/com/azure/communication/chat/ChatClient.java b/...ation/azure-communication-chat/src/main/java/com/azure/communication/chat/ChatClient.java
@@ -10,6 +10,7 @@
 import com.azure.core.annotation.ReturnType;
 import com.azure.core.annotation.ServiceClient;
 import com.azure.core.annotation.ServiceMethod;
+import com.azure.core.exception.HttpResponseException;
 import com.azure.core.http.rest.PagedIterable;
 import com.azure.core.http.rest.Response;
 import com.azure.core.http.rest.SimpleResponse;
@@ -52,6 +53,8 @@ public ChatThreadClient getChatThreadClient(String chatThreadId) {
      * Creates a chat thread.
      *
      * @param options Options for creating a chat thread.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the response.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
@@ -64,6 +67,8 @@ public CreateChatThreadResult createChatThread(CreateChatThreadOptions options)
      *
      * @param options Options for creating a chat thread.
      * @param context The context to associate with this operation.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the response.
      */
     @ServiceMethod(returns = ReturnType.SINGLE)
@@ -78,6 +83,8 @@ public Response<CreateChatThreadResult> createChatThreadWithResponse(CreateChatT
      * Deletes a chat thread.
      *
      * @param chatThreadId Chat thread id to delete.
+     * @throws HttpResponseException 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 deleteChatThread(String chatThreadId) {
@@ -89,6 +96,8 @@ public void deleteChatThread(String chatThreadId) {
      *
      * @param chatThreadId Chat thread id to delete.
      * @param context The context to associate with this operation.
+     * @throws HttpResponseException 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)
@@ -100,6 +109,8 @@ public Response<Void> deleteChatThreadWithResponse(String chatThreadId, Context
     /**
      * Gets the list of chat threads of a user.
      *
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the paged list of chat threads of a user.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)
@@ -113,6 +124,8 @@ public PagedIterable<ChatThreadItem> listChatThreads() {
      *
      * @param listThreadsOptions The request options.
      * @param context The context to associate with this operation.
+     * @throws HttpResponseException thrown if the request is rejected by server.
+     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
      * @return the paged list of chat threads of a user.
      */
     @ServiceMethod(returns = ReturnType.COLLECTION)