Skip to content

Update ACS release notes march [deprecated] #2547

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.

Sign up for GitHub

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

Closed
garchiro7 wants to merge 3 commits into from
Closed

Update ACS release notes march [deprecated] #2547

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7e2bf97
Update ACS release notes march 21
Mar 10, 2021
989b8de
Update review comments
Mar 10, 2021
b1246c9
update android comments
Mar 10, 2021
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
108 changes: 102 additions & 6 deletions releases/2021-03/android.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ The Azure SDK team is pleased to announce our March 2021 client library releases

#### Beta

- _Add packages_
- Azure Communication Services Chat
- Azure Communication Services Common

## Installation Instructions

Expand All @@ -27,20 +28,71 @@ To use the latest GA and beta libraries, refer to the dependency information bel
### Gradle

#### Java

```gradle
// Insert dependencies
allprojects {
repositories {
...
maven {
url 'https://trouterpublicpackages.z13.web.core.windows.net'
}
}

dependencies {
...
implementation 'com.azure.android:azure-communication-chat:1.0.0-beta.7'
implementation 'com.azure.android:azure-communication-common:1.0.0-beta.7'
implementation 'com.microsoft.trouter:client-android:0.0.1-beta.1'
Copy link
Member

@vcolin7 vcolin7 Mar 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If Trouter is closed-source I think we should not include it in the release notes. We use these to announce changes made to our Azure SDK libraries.

Copy link
Member

@vcolin7 vcolin7 Mar 10, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JP mentioned that customers need to include this in their projects for the signaling part to work correctly, but I think instructions like these should be indicated in the README. Although I'm not entirely sure why they would need to do so if Trouter is a dependency of ACS Chat already. Are there any cases where customers would want to use Trouter APIs themselves?

}
```

#### Kotlin

```gradle
// Insert dependencies
allprojects {
repositories {
...
maven {
url 'https://trouterpublicpackages.z13.web.core.windows.net'
}
}
dependencies {
...
implementation("com.azure.android:azure-communication-chat:1.0.0-beta.7")
implementation("com.azure.android:azure-communication-common:1.0.0-beta.7")
implementation("com.microsoft.trouter:client-android:0.0.1-beta.1")
}
```

### Maven

```xml
<!-- Insert dependencies -->
<repositories>
...
<repository>
<id>troutersource</id>
<url>https://trouterpublicpackages.z13.web.core.windows.net</url>
</repository>
</repositories>
...
<dependency>
<groupId>com.azure.android</groupId>
<artifactId>azure-communication-chat</artifactId>
<version>1.0.0-beta.7</version>
<type>aar</type>
</dependency>
<dependency>
<groupId>com.azure.android</groupId>
<artifactId>azure-communication-common</artifactId>
<version>1.0.0-beta.7</version>
<type>aar</type>
</dependency>
<dependency>
<groupId>com.microsoft.trouter</groupId>
<artifactId>client-android</artifactId>
<version>0.0.1-beta.1</version>
<type>aar</type>
</dependency>
```

## Feedback
Expand All @@ -49,9 +101,53 @@ If you have a bug or feature request for one of the libraries, please post an is

## Release highlights

### _Package name_
### Azure Communication Services Common

#### 1.0.0-beta.7 ([Changelog](https://github.com/Azure/azure-sdk-for-android/blob/master/sdk/communication/azure-communication-common/CHANGELOG.md#100-beta7-2021-03-09))

##### Breaking Changes

- Credential `getToken` now returns the newly added `CommunicationAccessToken` object instead of `AccessToken`.
- Renamed `getRefreshProactively` to `isRefreshProactively` in 'CommunicationTokenRefreshOptions'.
- Removed constructor `MicrosoftTeamsUserIdentifier(String userId, boolean isAnonymous, CommunicationCloudEnvironment cloudEnvironment)` in `MicrosoftTeamsUserIdentifier`.
- Made the following classes final:
- `CommunicationAccessToken`
- `CommunicationTokenCredential`
- `CommunicationTokenRefreshOptions`
- `CommunicationUserIdentifier`
- `MicrosoftTeamsUserIdentifier`
- `PhoneNumberIdentifier`
- `UnknownIdentifier`

##### New Features

- Introduced a new class: `CommunicationAccessToken`.

### Azure Communication Services Chat

#### 1.0.0-beta.7 ([Changelog](https://github.com/Azure/azure-sdk-for-android/blob/master/sdk/communication/azure-communication-chat/CHANGELOG.md#100-beta7-2021-03-09))

##### New Features

- Added support for real time notifications with new methods in `ChatClient` /`ChatAsyncClient`:
- `startRealtimeNotifications`
- stopRealtimeNotifications`
- `on(chatEventId, listenerId, listener)`
- `off(chatEventId, listenerId)`
- Added a sample chat app under the folder `samples` with the purpose of testing and playing around with the chat functionality.

##### Breaking Changes

- Major changes only!
- Changed `userId` from the type `CommunicationUserIdentifier` to `CommunicationIdentifierModel` in the following classes:
- `ChatMessage`
- `ChatMessageContent`
- `ChatMessageReadReceipt`
- `ChatParticipant`
- `ChatThread`
- Renamed property `initiator` to `initiatorCommunicationIdentifier` in `ChatMessageContent`.
- Renamed `senderId` to `senderCommunicationIdentifier` in `ChatMessage` and `ChatMessageReadReceipt`.
- Renamed `identifier` to `communicationIdentifier` in `ChatParticipant`.
- Renamed `createdBy` to `createdByCommunicationIdentifier` in `ChatThread`.

## Need help

Expand Down
65 changes: 64 additions & 1 deletion releases/2021-03/dotnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,22 @@ The Azure SDK team is pleased to announce our March 2021 client library releases

[pattern.beta]: # (- ${PackageFriendlyName})

- Communication Chat
- Communication Common
- Communication Identity
- Communication Phone Numbers
- Communication SMS

## Installation Instructions

To install any of our packages, please search for them via `Manage NuGet Packages...` in Visual Studio (with `Include prerelease` checked) or copy these commands into your terminal:

```bash

$> dotnet add package Azure.Communication.Chat --version 1.0.0-beta.5
$> dotnet add package Azure.Communication.Common --version 1.0.0-beta.5
$> dotnet add package Azure.Communication.Identity --version 1.0.0-beta.5
$> dotnet add package Azure.Communication.PhoneNumbers --version 1.0.0-beta.5
$> dotnet add package Azure.Communication.SMS --version 1.0.0-beta.5
```

[pattern]: # ($> dotnet install ${PackageName} --version ${PackageVersion})
Expand All @@ -42,6 +52,59 @@ If you have a bug or feature request for one of the libraries, please [file an i

[pattern]: # (### ${PackageFriendlyName} ${PackageVersion} [Changelog]${ChangelogUrl}`n${HighlightsBody}`n)


### Azure Communication Administration is deprecated

- `PhoneNumberAdministrationClient` is moved into the new package `Azure.Communication.PhoneNumbers` and replaced by `PhoneNumberClient`.

### Azure Communication Phone Numbers 1.0.0-beta.5 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.PhoneNumbers/CHANGELOG.md#100-beta5-2021-03-09)

#### New Features

- Added `PhoneNumbersClient` (originally was part of the `Azure.Communication.Administration` package).
- Added support for Azure Active Directory Authentication.

#### Breaking Changes

- `PhoneNumberAdministrationClient` has been replaced with `PhoneNumbersClient`, which has the same functionality but different APIs. To learn more about how PhoneNumbersClient works, refer to the [README.md](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.PhoneNumbers/README.md)

### Azure Communication Chat 1.0.0-beta.5 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.Chat/CHANGELOG.md#100-beta5-2021-03-09)

#### Breaking Changes

- Added support for communication identifiers instead of raw strings.
- Removed support for nullable reference types.

### Azure Communication Common 1.0.0-beta.5 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.Common/CHANGELOG.md#100-beta5-2021-03-09)

#### Breaking Changes

- Updated `CommunicationTokenRefreshOptions(bool refreshProactively, Func<CancellationToken, string> tokenRefresher, Func<CancellationToken, ValueTask<string>> asyncTokenRefresher = null, string initialToken = null)`
to `CommunicationTokenRefreshOptions(bool refreshProactively, Func<CancellationToken, string> tokenRefresher)`. `asyncTokenRefresher` and `initialToken` are updated to become public properties.

### Azure Communication Identity 1.0.0-beta.5 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.Identity/CHANGELOG.md#100-beta5-2021-03-09)

#### Breaking Changes

- `CommunicationIdentityClient.IssueToken` and `CommunicationIdentityClient.IssueTokenAsync` are renamed to `GetToken` and `GetTokenAsync`, respectively
- `CommunicationIdentityClient.CreateUserWithToken` and `CommunicationIdentityClient.CreateUserWithTokenAsync` are renamed to `CreateUserAndToken` and `CreateUserAndTokenAsync`, respectively. Their return value is also changed from `Tuple<CommunicationUserIdentifier, string>` to `CommunicationUserIdentifierAndToken`.

### Azure Communication SMS 1.0.0-beta.4 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/communication/Azure.Communication.Sms/CHANGELOG.md#100-beta4-2021-03-09)

#### New Features

- Added support to create SmsClient with AzureKeyCredential.
- Support for creating SmsClient with TokenCredential.
- Added support for 1:N SMS messaging.
- Added support for tagging SMS messages.
- Send method series in SmsClient are idempotent under retry policy.

#### Breaking Changes

- Updated `Task<Response<SendSmsResponse>> SendAsync(PhoneNumberIdentifier from, PhoneNumberIdentifier to, string message, SendSmsOptions sendSmsOptions = null, CancellationToken cancellationToken = default)`
to `Task<Response<SmsSendResult>> SendAsync(string from, string to, string message, SmsSendOptions options = default)`
- Replaced `SendSmsResponse` with `SmsSendResult`

## Latest Releases

View all the latest versions of .NET packages [here][dotnet-latest-releases].
Expand Down
106 changes: 104 additions & 2 deletions releases/2021-03/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,47 @@ The Azure SDK team is pleased to announce our March 2021 client library releases

#### Beta

[pattern.beta]: # (- ${PackageFriendlyName})
- Azure Communication Common
- Azure Communication Identity
- Azure Communication Chat
- Azure Communication Phone Numbers
- Azure Communication SMS

## Installation Instructions

To use the GA and beta libraries, refer to the Maven dependency information below, which may be copied into your projects Maven `pom.xml` file as appropriate. If you are using a different build tool, refer to its documentation on how to specify dependencies.

```xml
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-communication-chat</artifactId>
<version>1.0.0-beta.6</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-communication-common</artifactId>
<version>1.0.0-beta.6</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-communication-identity</artifactId>
<version>1.0.0-beta.6</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-communication-phonenumbers</artifactId>
<version>1.0.0-beta.6</version>
</dependency>

<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-communication-sms</artifactId>
<version>1.0.0-beta.4</version>
</dependency>


```

Expand All @@ -40,7 +74,75 @@ If you have a bug or feature request for one of the libraries, please post an is

## Release highlights

[pattern]: # (### ${PackageFriendlyName} ${PackageVersion} [Changelog]${ChangelogUrl}`n${HighlightsBody}`n)
### Azure Communication Administration is deprecated

- Phone number administration will be moved into a new package Azure Communication Phone Numbers.

### Azure Communication Phone Numbers 1.0.0-beta.6 [Changelog](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-phonenumbers/CHANGELOG.md#100-beta6-2021-03-09)

#### New Features

- Added `PhoneNumbersClient` and `PhoneNumbersAsyncClient` (originally was part of the `azure.communication.administration` package).
- Added support for Azure Active Directory Authentication.

#### Breaking Changes

- `PhoneNumberAsyncClient` has been replaced with `PhoneNumbersAsyncClient`, which has the same functionality but different APIs. To learn more about how PhoneNumbersAsyncClient works, refer to the [README.md](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-phonenumbers/README.md).
- `PhoneNumberClient` has been replaced with `PhoneNumbersClient`, which has the same functionality but different APIs. To learn more about how PhoneNumbersClient works, refer to the [README.md](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-phonenumbers/README.md).





### Azure Communication Common 1.0.0-beta.6 [Changelog](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-common/CHANGELOG.md#100-beta6-2021-03-09)

#### Breaking Changes

- Renamed `CommunicationTokenRefreshOptions.getRefreshProactively()` to `CommunicationTokenRefreshOptions.isRefreshProactively()`
- Constructor for `CommunicationCloudEnvironment` has been removed and now to set an environment value, the `fromString()` method must be called
- `CommunicationCloudEnvironment`, `CommunicationTokenRefreshOptions `, `CommunicationUserIdentifier`, `MicrosoftTeamsUserIdentifier`,
`PhoneNumberIdentifier`, `UnknownIdentifier`, are all final classes now.

### Azure Communication Chat 1.0.0-beta.6 [Changelog](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-chat/CHANGELOG.md#100-beta6-2021-03-09)

#### New Features

- Updated azure-communication-chat version


### Azure Communication Identity 1.0.0-beta.6 [Changelog](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-identity/CHANGELOG.md#100-beta6-2021-03-09)

#### New Features

- Added a retryPolicy() chain method to the `CommunicationIdentityClientBuilder`.

#### Breaking Changes

- `CommunicationIdentityClient.createUserWithToken` and `CommunicationIdentityAsyncClient.createUserWithToken` have been renamed to
`CommunicationIdentityClient.createUserAndToken` and `CommunicationIdentityAsyncClient.createUserAndToken`.
- `CommunicationIdentityClient.createUserWithTokenWithResponse` and `CommunicationIdentityAsyncClient.createUserWithTokenWithResponse` have been renamed to
`CommunicationIdentityClient.createUserAndTokenWithResponse` and `CommunicationIdentityAsyncClient.createUserAndTokenWithResponse`.
- `CommunicationUserIdentifierWithTokenResult` class has been renamed to `CommunicationUserIdentifierAndToken`.


### Azure Communication SMS 1.0.0-beta.4 [Changelog](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/communication/azure-communication-sms/CHANGELOG.md#100-beta4-2021-03-09)

#### New Features

- Added Azure Active Directory authentication support
- Support for creating SmsClient with TokenCredential.
- Added support for 1:N SMS messaging.
- Added support for tagging SMS messages.
- Send method series in SmsClient are idempotent under retry policy.
- Added `SmsOptions`

#### Breaking Changes

- Updated `public Mono<SendSmsResponse> sendMessage(PhoneNumberIdentifier from, PhoneNumberIdentifier to, String message)` to `public Mono<SendSmsResponse> send(String from, String to, String message)`.
- Updated `public Mono<Response<SendSmsResponse>> sendMessageWithResponse(PhoneNumberIdentifier from,List<PhoneNumberIdentifier> to, String message, SendSmsOptions smsOptions, Context context)` to `Mono<Response<SmsSendResult>> sendWithResponse(String from, String to, String message, SmsSendOptions options, Context context)`.
- Replaced `SendSmsResponse` with `SmsSendResult`.



## Need help

Expand Down
Loading