[communication] prep release for common, identity, chat (#18586)

Azure · Feb 9, 2021 · 54edf81 · 54edf81
1 parent 30a070e
commit 54edf81
Show file tree

Hide file tree

Showing 11 changed files with 166 additions and 20 deletions.
diff --git a/sdk/communication/Azure.Communication.Chat/CHANGELOG.md b/sdk/communication/Azure.Communication.Chat/CHANGELOG.md
@@ -1,13 +1,20 @@
 # Release History
 
-## 1.0.0-beta.4 (2021-02-08)
-# Breaking
-- Support for CreateChatThreadResult and AddChatParticipantsResult to handle partial errors in batch calls.
+## 1.0.0-beta.4 (2021-02-09)
+
+### Breaking Changes
+
+- Updated to Azure.Communication.Common version 1.0.0-beta.4. Now uses `CommunicationUserIdentifier` and `CommunicationIdentifier` in place of `CommunicationUser`, and `CommunicationTokenCredential` instead of `CommunicationUserCredential`.
+- Removed `Priority` field from `ChatMessage`.
+
+### Added
+
+- Added support for `CreateChatThreadResult` and `AddChatParticipantsResult` to handle partial errors in batch calls.
 - Added idempotency identifier parameter for chat creation calls.
-- Added support for readreceipts and getparticipants pagination.
-- Added new model for messages anc ontent types : Text, Html, ParticipantAdded, ParticipantRemoved, TopicUpdated 
-- Removed priority field (ChatMessage.Priority)
-- Added new model for errors (CommunicationError)
+- Added pagination support for `GetReadReceipts`, `GetReadReceiptsAsync` and `GetParticipants`, `GetParticipantsAsync`.
+- Added new model for messages and content types: `Text`, `Html`, `ParticipantAdded`, `ParticipantRemoved`, `TopicUpdated`.
+- Added new model for errors (`CommunicationError`).
+- Added notifications for thread level changes.
 
 
 ## 1.0.0-beta.3 (2020-11-16)

diff --git a/sdk/communication/Azure.Communication.Chat/README.md b/sdk/communication/Azure.Communication.Chat/README.md
@@ -2,7 +2,7 @@
 
 > Server - Chat Api Version:  2020-11-01-preview3
 
-> Client - Chat SDK Version:  1.0.0-beta.3
+> Client - Chat SDK Version:  1.0.0-beta.4
 
 This package contains a C# SDK for Azure Communication Services for chat.
 

diff --git a/sdk/communication/Azure.Communication.Common/CHANGELOG.md b/sdk/communication/Azure.Communication.Common/CHANGELOG.md
@@ -1,17 +1,18 @@
 # Release History
 
-## 1.0.0-beta.4 (Unreleased)
+## 1.0.0-beta.4 (2021-02-09)
 
 ### Added
 - Added `MicrosoftTeamsUserIdentifier`.
 
 ### Breaking Changes
 - Renamed `CommunicationUserCredential` to `CommunicationTokenCredential`.
-- Replace `CommunicationTokenCredential(bool refreshProactively, Func<CancellationToken, string> tokenRefresher,Func<CancellationToken, ValueTask<string>>? asyncTokenRefresher = null, string? initialToken = null)` 
+- Replaced `CommunicationTokenCredential(bool refreshProactively, Func<CancellationToken, string> tokenRefresher,Func<CancellationToken, ValueTask<string>>? asyncTokenRefresher = null, string? initialToken = null)`.
 with `CommunicationTokenCredential(CommunicationTokenRefreshOptions tokenRefreshOptions)`.
-- Renamed `PhoneNumber` to `PhoneNumberIdentifier`
-- Renamed `CommunicationUser` to `CommunicationUserIdentifier `
-- Renamed `CallingApplication` to `CallingApplicationIdentifier`
+- Renamed `PhoneNumber` to `PhoneNumberIdentifier`.
+- Renamed `CommunicationUser` to `CommunicationUserIdentifier`.
+- Removed `CallingApplication`.
+- Renamed `Id` to `RawId` in `PhoneNumberIdentifier`.
 
 ## 1.0.0-beta.3 (2020-11-16)
 Updated `Azure.Communication.Common` version.

diff --git a/sdk/communication/Azure.Communication.Common/README.md b/sdk/communication/Azure.Communication.Common/README.md
@@ -9,7 +9,7 @@ This package contains common code for Azure Communication Service libraries.
 Install the Azure Communication Common client library for .NET with [NuGet][nuget].
 
 ```Powershell
-dotnet add package Azure.Communication.Common --version 1.0.0-beta.3
+dotnet add package Azure.Communication.Common --version 1.0.0-beta.4
 ```
 
 ### Prerequisites

diff --git a/sdk/communication/Azure.Communication.Identity/CHANGELOG.md b/sdk/communication/Azure.Communication.Identity/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.0-beta.4 (Unreleased)
+## 1.0.0-beta.4 (2021-02-09)
 
 ### Added
 - Added CommunicationIdentityClient (originally was part of the Azure.Communication.Administration package).

diff --git a/sdk/communication/Azure.Communication.Identity/README.md b/sdk/communication/Azure.Communication.Identity/README.md
@@ -14,7 +14,7 @@ Azure Communication Identity is managing tokens for Azure Communication Services
 Install the Azure Communication Identity client library for .NET with [NuGet][nuget]:
 
 ```Powershell
-dotnet add package Azure.Communication.Identity --version 1.0.0-beta.3
+dotnet add package Azure.Communication.Identity --version 1.0.0-beta.4
 ```
 
 ### Prerequisites
@@ -41,7 +41,15 @@ var connectionString = "<connection_string>";
 var client = new CommunicationIdentityClient(connectionString);
 ```
 
-Clients also have the option to authenticate using a valid token.
+Or alternatively using the endpoint and access key acquired from an Azure Communication Resources in the [Azure Portal][azure_portal].
+
+```C# Snippet:CreateCommunicationIdentityFromAccessKey
+var endpoint = new Uri("https://my-resource.communication.azure.com");
+var accessKey = "<access_key>";
+var client = new CommunicationIdentityClient(endpoint, new AzureKeyCredential(accessKey));
+```
+
+Clients also have the option to authenticate using a valid Active Directory token.
 
 ```C# Snippet:CreateCommunicationIdentityFromToken
 var endpoint = new Uri("https://my-resource.communication.azure.com");

diff --git a/...ion/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClient.md b/...ion/Azure.Communication.Identity/samples/Sample1_CommunicationIdentityClient.md
@@ -18,7 +18,15 @@ var connectionString = "<connection_string>";
 var client = new CommunicationIdentityClient(connectionString);
 ```
 
-Clients also have the option to authenticate using a valid token.
+Or alternatively using the endpoint and access key acquired from an Azure Communication Resources in the [Azure Portal][azure_portal].
+
+```C# Snippet:CreateCommunicationIdentityFromAccessKey
+var endpoint = new Uri("https://my-resource.communication.azure.com");
+var accessKey = "<access_key>";
+var client = new CommunicationIdentityClient(endpoint, new AzureKeyCredential(accessKey));
+```
+
+Clients also have the option to authenticate using a valid Active Directory token.
 
 ```C# Snippet:CreateCommunicationIdentityFromToken
 var endpoint = new Uri("https://my-resource.communication.azure.com");

diff --git a/...zure.Communication.Identity/samples/Sample1_CommunicationIdentityClientAsync.md b/...zure.Communication.Identity/samples/Sample1_CommunicationIdentityClientAsync.md
@@ -18,7 +18,15 @@ var connectionString = "<connection_string>";
 var client = new CommunicationIdentityClient(connectionString);
 ```
 
-Clients also have the option to authenticate using a valid token.
+Or alternatively using the endpoint and access key acquired from an Azure Communication Resources in the [Azure Portal][azure_portal].
+
+```C# Snippet:CreateCommunicationIdentityFromAccessKey
+var endpoint = new Uri("https://my-resource.communication.azure.com");
+var accessKey = "<access_key>";
+var client = new CommunicationIdentityClient(endpoint, new AzureKeyCredential(accessKey));
+```
+
+Clients also have the option to authenticate using a valid Active Directory token.
 
 ```C# Snippet:CreateCommunicationIdentityFromToken
 var endpoint = new Uri("https://my-resource.communication.azure.com");

diff --git a/...tests/SessionRecords/Sample1_CommunicationIdentityClient/CreateIdentityWithAccessKey.json b/...tests/SessionRecords/Sample1_CommunicationIdentityClient/CreateIdentityWithAccessKey.json
diff --git a/.../SessionRecords/Sample1_CommunicationIdentityClient/CreateIdentityWithAccessKeyAsync.json b/.../SessionRecords/Sample1_CommunicationIdentityClient/CreateIdentityWithAccessKeyAsync.json
diff --git a/...ication/Azure.Communication.Identity/tests/samples/Sample1_CommunicationIdentityClient.cs b/...ication/Azure.Communication.Identity/tests/samples/Sample1_CommunicationIdentityClient.cs
@@ -113,6 +113,28 @@ public async Task CreateIdentityWithToken()
             }
         }
 
+        [Test]
+        public async Task CreateIdentityWithAccessKey()
+        {
+            #region Snippet:CreateCommunicationIdentityFromAccessKey
+            var endpoint = new Uri("https://my-resource.communication.azure.com");
+            var accessKey = "<access_key>";
+            /*@@*/ endpoint = TestEnvironment.Endpoint;
+            /*@@*/ accessKey = TestEnvironment.AccessKey;
+            var client = new CommunicationIdentityClient(endpoint, new AzureKeyCredential(accessKey));
+            #endregion Snippet:CreateCommunicationIdentityFromAccessKey
+
+            client = CreateClientWithAzureKeyCredential();
+            try
+            {
+                Response<CommunicationUserIdentifier> userResponse = await client.CreateUserAsync();
+            }
+            catch (Exception ex)
+            {
+                Assert.Fail($"Unexpected error: {ex}");
+            }
+        }
+
         [Test]
         public async Task Troubleshooting()
         {
@@ -131,7 +153,7 @@ public async Task Troubleshooting()
             {
                 Console.WriteLine(ex.Message);
             }
-            #endregion
+            #endregion Snippet:CommunicationIdentityClient_Troubleshooting
             catch (Exception ex)
             {
                 Assert.Fail($"Unexpected error: {ex}");