Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions sdk/communication/Azure.Communication.Chat/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# 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

- Renamed `CommunicationUser` to `CommunicationUserIdentifier`.
- Renamed `CommunicationUserCredential` to `CommunicationTokenCredential`.
- 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`.
DominikMe marked this conversation as resolved.
Show resolved Hide resolved
- Added new model for errors (`CommunicationError`).
- Added notifications for thread level changes.


## 1.0.0-beta.3 (2020-11-16)
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/Azure.Communication.Chat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 6 additions & 5 deletions sdk/communication/Azure.Communication.Common/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)`.
DominikMe marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/Azure.Communication.Common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
12 changes: 10 additions & 2 deletions sdk/communication/Azure.Communication.Identity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -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()
{
Expand All @@ -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}");
Expand Down