Skip to content

Commit

Permalink
[Communication]: Update missing release notes for communication (#2398)
Browse files Browse the repository at this point in the history
* Update release notes for communication beta packages

* Update release notes for dotnet, ios, js, and python

* Fix typo; add administration deprecation to dotnet.md

* Revert ios.md change; add deprecation info to python.md

* Simple format change

Co-authored-by: JP Chen <[email protected]>
  • Loading branch information
JianpingChen and JP Chen authored Feb 12, 2021
1 parent f15d2db commit c12537e
Show file tree
Hide file tree
Showing 4 changed files with 142 additions and 1 deletion.
1 change: 1 addition & 0 deletions releases/2021-02/android.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ To use the latest GA and beta libraries, refer to the dependency information bel
### Gradle

#### Java

```gradle
dependencies {
...
Expand Down
51 changes: 51 additions & 0 deletions releases/2021-02/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,57 @@ Thank you to our developer community members who helped to make the Service Bus
- Renamed `SearchIndexingBufferedSenderOptions<T>.RetryDelay` to `SearchIndexingBufferedSenderOptions<T>.ThrottlingDelay`.
- Removed the helper method `SearchClient.CreateIndexingBufferedSender<T>()`. Instead, callers are expected to use the public constructor of `SearchIndexingBufferedSender<T>`.

### Azure Communication Administration will be deprecated

- Identity client is moved to new package Azure Communication Identity.
- Phone number administration will be moved into a new package Azure Communication Phone Numbers.

### Azure Communication Common 1.0.0-beta.4 [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Communication.Common_1.0.0-beta.4/sdk/communication/Azure.Communication.Common/CHANGELOG.md#100-beta4-2021-02-09)

#### New Features

- Added MicrosoftTeamsUserIdentifier.

#### Breaking Changes

- Renamed CommunicationUserCredential to CommunicationTokenCredential.
- 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.
- Removed CallingApplication.
- Renamed Id to RawId in PhoneNumberIdentifier.

### Azure Communication Identity 1.0.0-beta.4 [ChangeLog](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Communication.Identity_1.0.0-beta.4/sdk/communication/Azure.Communication.Identity/CHANGELOG.md#100-beta4-2021-02-09)

### New Features

- Added CommunicationIdentityClient (originally was part of the Azure.Communication.Administration package).
- Added support to create CommunicationIdentityClient with TokenCredential.
- Added support to create CommunicationIdentityClient with AzureKeyCredential.
- Added ability to create a user and issue token for it at the same time.

### Breaking Changes

- CommunicationTokenScope.Pstn is removed.
- CommunicationIdentityClient.RevokeTokens now revoke all the currently issued tokens instead of revoking tokens issued prior to a given time.
- CommunicationIdentityClient.IssueToken returns an instance of `Azure.Core.AccessToken` instead of `CommunicationUserToken`.

### Azure Communication Chat (1.0.0-beta.4) [ChangeLog](https://github.com/Azure/azure-sdk-for-java/blob/azure-communication-chat_1.0.0-beta.4/sdk/communication/azure-communication-chat/CHANGELOG.md#100-beta4-2021-02-09)

#### New Features

- Added support for `CreateChatThreadResult` and `AddChatParticipantsResult` to handle partial errors in batch calls.
- Added idempotency identifier parameter for chat creation calls.
- 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.

#### 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`.

### Synapse Artifacts [Changelog](https://github.com/Azure/azure-sdk-for-net/blob/Azure.Analytics.Synapse.Artifacts_1.0.0-preview.6/sdk/synapse/Azure.Analytics.Synapse.Artifacts/CHANGELOG.md#100-preview6-2021-02-10)

#### New Features
Expand Down
53 changes: 52 additions & 1 deletion releases/2021-02/js.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,18 @@ The Azure SDK team is pleased to make available the February 2021 client library

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

- Azure Communication Common 1.0.0-beta.5
- Azure Communication Identity 1.0.0-beta.4
- Azure Communication Chat 1.0.0-beta.4

## Installation Instructions

To install the packages, copy and paste the below into a terminal.

```bash

$> npm install @azure/communication-common
$> npm install @azure/communication-identity
$> npm install @azure/communication-chat
```

[pattern]: # ($> npm install ${PackageName}@${PackageVersion})
Expand All @@ -42,6 +48,51 @@ If you have a bug or feature request for one of the libraries, please post an is

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

### Azure Communication Administration will be deprecated

- Identity client is moved to new package Azure Communication Identity.
- Phone number administration will be moved into a new package Azure Communication Phone Numbers.

### Azure Communication Common 1.0.0-beta.5 [ChangeLog](https://github.com/Azure/azure-sdk-for-js/blob/@azure/communication-common_1.0.0-beta.5/sdk/communication/communication-common/CHANGELOG.md#100-beta5-2021-02-09)

#### Breaking Changes

- Removed `CallingApplicationIdentifier` and `isCallingApplicationIdentifier`.
- Removed `id` from `CommunicationUserIdentifier`.
- Renamed `id` to `rawId` in `PhoneNumberIdentifier`.
- Renamed `id` to `rawId` in `MicrosoftTeamsUserIdentifier`.

### Azure Communication Identity 1.0.0-beta.4 [ChangeLog](https://github.com/Azure/azure-sdk-for-js/blob/@azure/communication-identity_1.0.0-beta.4/sdk/communication/communication-identity/CHANGELOG.md#100-beta4-2021-02-09)

#### New Features

- Added `CommunicationIdentityClient` (originally part of the `@azure/communication-administration` package).
- `CommunicationIdentityClient` added a constructor that supports `TokenCredential`.
- `CommunicationIdentityClient` added a new method `createUserWithToken`.

#### Breaking Changes

- Replaced `CommunicationUser` with `CommunicationUserIdentifier`.
- `CommunicationIdentityClient` method `revokeTokens` no longer accepts `tokensValidFrom` as an argument.
- `pstn` is removed from `TokenScope`
- `issueToken` no longer returns the `CommunicationUser` alongside the token.

### Azure Communication Chat 1.0.0-beta.4 [ChangeLog](https://github.com/Azure/azure-sdk-for-js/blob/@azure/communication-chat_1.0.0-beta.4/sdk/communication/communication-chat/CHANGELOG.md#100-beta4-2021-02-09)

#### New Features

- Added support for `CreateChatThreadResult` and `AddChatParticipantsResult` to handle partial errors in batch calls.
- Added idempotency identifier parameter for chat creation calls.
- Added support for `listReadReceipts` and `listParticipants` pagination.
- Added new model for messages an content types : `Text`, `Html`, `ParticipantAdded`, `ParticipantRemoved`, `TopicUpdated`.
- Added new model for errors (`CommunicationError`)
- Added notifications for thread level changes.

#### Breaking Changes

- Updated to @azure/communication-common@1.0.0-beta.5. Now uses `CommunicationUserIdentifier` in place of `CommunicationUser`, and `CommunicationTokenCredential` instead of `CommunicationUserCredential`.
- Removed `priority` field from `ChatMessage`.

## Latest Releases

View all the latest versions of JavaScript packages [here][js-latest-releases].
Expand Down
38 changes: 38 additions & 0 deletions releases/2021-02/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ The Azure SDK team is pleased to make available the February 2021 client library

- Form Recognizer
- Text Analytics
- Azure Communication Identity 1.0.0b4
- Azure Communication Chat 1.0.0b4

## Installation Instructions

Expand All @@ -29,6 +31,8 @@ To install the latest beta version of the packages, copy and paste the following
pip install azure-eventhub
pip install azure-ai-formrecognizer --pre
pip install azure-ai-textanalytics --pre
pip install azure-communication-identity
pip install --pre azure-communication-chat
```

## Feedback
Expand Down Expand Up @@ -60,6 +64,40 @@ actions results in the same order.
- Redesigned `begin_analyze_healthcare` and renamed it to `begin_analyze_healthcare_entities`. To help with navigation of related entities, we have also
added property `related_entities` for each entity returned from this call.

### Azure Communication Administration will be deprecated

- Identity client is moved to new package Azure Communication Identity.
- Phone number administration will be moved into a new package Azure Communication Phone Numbers.

### Azure Communication Identity 1.0.0b4 [ChangeLog](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-identity_1.0.0b4/sdk/communication/azure-communication-identity/CHANGELOG.md#100b4-2021-02-09)

#### New Features

- Added CommunicationIdentityClient (originally was part of the azure.communication.administration package).
- Added ability to create a user and issue token for it at the same time.

#### Breaking Changes

- CommunicationIdentityClient.revoke_tokens now revoke all the currently issued tokens instead of revoking tokens issued prior to a given time.
- CommunicationIdentityClient.issue_tokens returns an instance of `azure.core.credentials.AccessToken` instead of `CommunicationUserToken`.

### Azure Communication Chat 1.0.0b4 [ChangeLog](https://github.com/Azure/azure-sdk-for-python/blob/azure-communication-chat_1.0.0b4/sdk/communication/azure-communication-chat/CHANGELOG.md#100b4-2021-02-09)

### New Features

- 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.
- Added new model for errors (CommunicationError).
- Added `MicrosoftTeamsUserIdentifier`.

#### Breaking Changes

- Uses `CommunicationUserIdentifier` and `CommunicationIdentifier` in place of `CommunicationUser`, and `CommunicationTokenCredential` instead of `CommunicationUserCredential`.
- Removed priority field (ChatMessage.Priority).
- Renamed PhoneNumber to PhoneNumberIdentifier.

## Latest Releases

View all the latest versions of Python packages [here][python-latest-releases].
Expand Down

0 comments on commit c12537e

Please sign in to comment.