From c3d8867039536b5a6c2529be981a0eec03bd05f5 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Tue, 26 Oct 2021 15:08:58 +0800 Subject: [PATCH] prepare webpubsub beta.5 release (#25033) * update changelog * update readme --- .../azure-messaging-webpubsub/CHANGELOG.md | 18 ++++++++++- .../azure-messaging-webpubsub/README.md | 31 ++++++------------- 2 files changed, 27 insertions(+), 22 deletions(-) diff --git a/sdk/webpubsub/azure-messaging-webpubsub/CHANGELOG.md b/sdk/webpubsub/azure-messaging-webpubsub/CHANGELOG.md index b5b591ff07e0..f30c0c2d8126 100644 --- a/sdk/webpubsub/azure-messaging-webpubsub/CHANGELOG.md +++ b/sdk/webpubsub/azure-messaging-webpubsub/CHANGELOG.md @@ -1,7 +1,23 @@ # Release History -## 1.0.0-beta.5 (Unreleased) +## 1.0.0-beta.5 (2021-10-26) +### Features Added + +- Added support for method `closeUserConnectionsWithResponse`, `closeGroupConnectionsWithResponse`, `closeAllConnectionsWithResponse` in `WebPubSubServiceClient` and `WebPubSubServiceAsyncClient`. + +### Breaking Changes + +- Renamed method `getAuthenticationToken` to `getClientAccessToken` in `WebPubSubServiceClient` and `WebPubSubServiceAsyncClient`. +- Type changed from `String` to `WebPubSubPermission` in method `checkPermissionWithResponse`, `grantPermissionWithResponse`, `revokePermissionWithResponse`, in `WebPubSubServiceClient` and `WebPubSubServiceAsyncClient`. +- Renamed class `WebPubSubAuthenticationToken` to `WebPubSubClientAccessToken`. +- Renamed method `getAuthToken` to `getToken` in `WebPubSubClientAccessToken`. + +### Other Changes + +#### Dependency Updates + +- Updated `api-version` to `2021-10-01`. ## 1.0.0-beta.4 (2021-09-08) diff --git a/sdk/webpubsub/azure-messaging-webpubsub/README.md b/sdk/webpubsub/azure-messaging-webpubsub/README.md index c08cc1ae35df..108a72aaafc4 100644 --- a/sdk/webpubsub/azure-messaging-webpubsub/README.md +++ b/sdk/webpubsub/azure-messaging-webpubsub/README.md @@ -35,9 +35,9 @@ requests, can also use Azure Web PubSub service. ### Create a Web PubSub client using connection string - + ```java -WebPubSubServiceClient webPubSubServiceClient = new WebPubSubClientBuilder() +WebPubSubServiceClient webPubSubServiceClient = new WebPubSubServiceClientBuilder() .connectionString("{connection-string}") .hub("chat") .buildClient(); @@ -45,25 +45,15 @@ WebPubSubServiceClient webPubSubServiceClient = new WebPubSubClientBuilder() ### Create a Web PubSub client using access key - + ```java -WebPubSubServiceClient webPubSubServiceClient = new WebPubSubClientBuilder() +WebPubSubServiceClient webPubSubServiceClient = new WebPubSubServiceClientBuilder() .credential(new AzureKeyCredential("{access-key}")) .endpoint("") .hub("chat") .buildClient(); ``` -### Create a Web PubSub Group client - -```java -WebPubSubServiceClient webPubSubServiceClient = new WebPubSubClientBuilder() - .credential(new AzureKeyCredential("{access-key}")) - .hub("chat") - .buildClient(); -WebPubSubGroup javaGroup = webPubSubServiceClient.getGroup("java"); -``` - ## Key concepts ### Hub @@ -100,28 +90,27 @@ A message is either an UTF-8 encoded string or raw binary data. ### Broadcast message to entire hub - + ```java -webPubSubServiceClient.sendToAll("Hello world!"); +webPubSubServiceClient.sendToAll("Hello world!", WebPubSubContentType.TEXT_PLAIN); ``` ### Broadcast message to a group - + ```java -WebPubSubGroup javaGroup = webPubSubServiceClient.getGroup("Java"); -javaGroup.sendToAll("Hello Java!", WebPubSubContentType.TEXT_PLAIN); +webPubSubServiceClient.sendToGroup("java", "Hello Java!", WebPubSubContentType.TEXT_PLAIN); ``` ### Send message to a connection - + ```java webPubSubServiceClient.sendToConnection("myconnectionid", "Hello connection!", WebPubSubContentType.TEXT_PLAIN); ``` ### Send message to a user - + ```java webPubSubServiceClient.sendToUser("Andy", "Hello Andy!", WebPubSubContentType.TEXT_PLAIN); ```