Release History

1.0.0-beta.9 (2021-03-10)

New Features

Azure Communication Chat

• Introduction of a new struct CommunicationIdentifierModel to repesent a union type that is either a communicationUser, phoneNumber, or microsoftTeamsUser.

Azure Communication Calling

• SDK is now shipped as a XCFramework instead of a FAT framework created using lipo.
• Improved caching of objects.
• Added new call state Hold when a remote participant puts the call on hold.

Breaking Changes

Azure Communication

• Removal of CommunicationCloudEnvironment.fromModel() method
• Removal of label identifier in CommunicationUserIdentifier and UnknownIdentifier
• CommunicationIdentifierModel and CommunicationIdentifierSerializer are no longer part of the communication package, they have been moved to AzureCommunicationChat

Azure Communication Chat

• On ChatClient create(thread) method, renamed repeatabilityRequestID to repeatabilityRequestId
• ChatThreadClient remove(participant) method now accepts CommunicationIdentifier instead of a string
• For Participant renamed user property to id

Azure Communication Calling

• Renderer renamed to VideoStreamRenderer.
• AudioDeviceInfo removed from DeviceManager, please use iOS system API's in your application to switch between audio devices.
• CallAgent raises a new event onIncomingCall when a new incoming call is received.
• CallAgent raises a new event onCallEnded event is raised when the incoming call wasn't answered.
• Accept and Reject can now be done on IncomingCall object and removed from Call object.
• For parsing of push notification payload IncomingCallPushNotification has been renamed to PushNotificationInfo.
• CallerInfo class created which provides information about the caller in an incoming call. Can be retrieved from IncomingCall and Call objects.

Key Bug Fixes

Azure Communication Calling

• OnCallsUpdated event is raised when the call collection on CallAgent is updated for outgoing calls.
• Hold and Resume of an active call is fixed.

1.0.0-beta.8 (2021-02-09)

New Features

Azure Communication Calling

• Added ability to join a Teams meeting.
• New event on Call OnIsRecordingActiveChanged to indicate when the recording has been started and stopped and new property IsRecordingActive to indicate if currently the recording is active or not.

Azure Communication Chat Library

• Introduced ChatClient and ChatThreadClient to split operations on threads and operations within a particular thread
• Create thread sets repeatability-Request-ID for idempotency if not provided
• Introduced MessageContent model to replace string content property

Breaking Changes

Azure Communication Common Library

• Renamed the type CommunicationUserCredential to CommunicationTokenCredential, as it represents a token.
• Communication identifier MicrosoftTeamsUserIdentifier property identifier renamed to userId since identifier was too generic.
• Communication identifier MicrosoftTeamsUserIdentifier property id renamed to rawId to represent full MRI.
• Communication identifier PhoneNumberIdentifier property id renamed to rawId to represent full MRI.
• Removed CallingApplicationIdentifier as it is currently unused by any service.
• The protocol CommunicationTokenCredential has likewise been renamed to CommunicationTokenCredentialProviding.
• All types that conform to the CommunicationIdentifier protocol now use the suffix Identifier. For example, the PhoneNumber type used to represent a phone number identifier is now named PhoneNumberIdentifier.
• Updated the CommunicationTokenCredential initializer that automatically refreshes the token to accept a single CommunicationTokenRefreshOptions object instead of multiple parameters.

Azure Communication Chat Library

• ChatThreadMember renamed to Participant, uses CommunicationUserIdentifier
• ChatMessage renamed to Message, uses CommunicationUserIdentifier
• ChatThread renamed to Thread, uses CommunicationUserIdentifier

Key Bug Fixes

Azure Communication Calling

• Fix wrong callId on the incoming Call object https://github.com/Azure/Communication/issues/164
• When placing outgoing call or joining a group call event will be raised OnCallsUpdated when call list is updated.
• Throw IllegalArgumentException if null camera is passed to constructor of LocalVideoStream.
• Video freezing in landscape mode https://github.com/Azure/Communication/issues/128
• RendererView layout is off after a device rotation https://github.com/Azure/Communication/issues/127
• RendererView is blank when not added to the window right away https://github.com/Azure/Communication/issues/132
• RendererView Issues when joining a call with a reused groupId https://github.com/Azure/Communication/issues/111

Azure Communication Common Library

• Removing CommunicationUserCredentialPolicy, this policy was a duplicate of cores BearerTokenCredentialPolicy.
  Communication now has new ability to create BearerTokenCredentialPolicy using the new CommunicationPolicyTokenCredential.

1.0.0-beta.7 (2021-01-12)

New Features

Azure Communication Calling Service

• Added the ability to set the Caller display name when initializing the library.

Azure Communication Common Library

• Added a new communication identifier MicrosoftTeamsUserIdentifier, used to represent a Microsoft Teams user.
• Introduced the new CommunicationTokenRefreshOptions type for specifying communication token refresh options.

Breaking Changes

Azure Communication Common Library

• Renamed the type CommunicationUserCredential to CommunicationTokenCredential, as it represents a token.
• The protocol CommunicationTokenCredential has likewise been renamed to CommunicationTokenCredentialProviding.
• All types that conform to the CommunicationIdentifier protocol now use the suffix Identifier. For example, the PhoneNumber type used to represent a phone number identifier is now named PhoneNumberIdentifier.
• Updated the CommunicationTokenCredential initializer that automatically refreshes the token to accept a single CommunicationTokenRefreshOptions object instead of multiple parameters.

Key Bug Fixes

Azure Communication Calling Service

• Fixed an issue where handlePushNotification did not return false if the same payload had been processed already.
• Improved logging to help identify the source of hangup-related issues reported in GitHub.
• Fixed an issue where the remote participant was still available after hangup/disconnect. #134

1.0.0-beta.6 (2020-11-23)

Key Bug Fixes

Azure Communication Calling Service

• Fixed crash on calling Call.hangup(). #106
• Fixed invalid values for CFBundleVersion and CFBundleShortVersionString in Info.plist. #113

1.0.0-beta.5 (2020-11-18)

New Features

• Added Cocoapods specs for AzureCore, AzureCommunication, AzureCommunicationChat, and AzureCommunicationCalling libraries.

Breaking Changes

Azure Communication Chat Service

• The baseUrl parameter has been renamed to endpoint in the AzureCommunicationChatClient initializers.

Azure Communication Calling Service

• Swift applications will not see the ACS prefix for classes and enums. For example, ACSCallAgent is now CallAgent when the library is imported in a Swift application.
• Parameter labels are now mandatory for all API calls from Swift applications.
• Except for the first parameter, parameter labels are now mandatory for all other parameters to delegate methods in Swift applications.
• An exception is now thrown if an application tries to render video/camera twice.

Key Bug Fixes

Azure Communication Calling Service

• Fixed a deadlock when deleting an ACSCallAgent object.
• The Call.hangup() method will return only after all necessary events are delivered to the app. #85
• The Call.hangup() method now terminates a call if the call is in the Connecting or Ringing state. #96
• The library was raising a RemoteVideoStream Removed event when app stopped rendering a stream. The library now also raises a follow-up RemoteVideoStream Added event once the stream is ready to be rendered again. #95

1.0.0-beta.2 (2020-10-05)

Version 1.0.0-beta.2 adds the Azure Communication Services Chat to the SDK.

Added Libraries

• Azure Communication Services Chat (AzureCommunicationChat)

1.0.0-beta.1 (2020-09-21):

Version 1.0.0-beta.1 is a beta of our efforts in creating a client library that is developer-friendly, idiomatic to the iOS ecosystem, and as consistent across different languages and platforms as possible. The principles that guide our efforts can be found in the Azure SDK Design Guidelines for iOS.

Added Libraries

• Azure SDK for iOS core (AzureCore)
• Azure Communication Services common (AzureCommunication)
  • This library is used by other libraries in this SDK, as well as by libraries in the Azure Communication SDKs.