Azure SDK for iOS (January 2021)
The Azure SDK team is pleased to announce our January 2021 client library releases.
Beta
- Azure Communication Services Calling
- Azure Communication Common
Installation Instructions
To install the latest GA and beta libraries, we recommend you use the Swift Package Manager. As an alternative, you may also integrate the libraries using CocoaPods.
Xcode
To add the Azure SDK for iOS to your application, follow the instructions in Adding Package Dependencies to Your App:
With your project open in Xcode 11 or later, select File > Swift Packages > Add Package Dependency… Enter the clone URL of this repository: https://github.com/Azure/azure-sdk-for-ios.git and click Next. For the version rule, specify the exact version or version range you wish to use with your application and click Next. Finally, place a checkmark next to each client library you wish to use with your application, ensure your application target is selected in the Add to target dropdown, and click Finish.
Swift CLI
Follow the example in Importing Dependencies:
Open your project’s Package.swift
file and add a new package dependency to your project’s dependencies
section, specifying the clone URL of the repository and the version specifier you wish to use:
dependencies: [
...
.package(url: "https://github.com/Azure/azure-sdk-for-ios.git", from: "1.0.0-beta.7")
],
Next, add each client library you wish to use in a target to the target’s array of dependencies
:
targets: [
...
.target(
name: "MyTarget",
dependencies: [
"AzureCommunication",
"AzureCommunicationCalling",
...
]
)
]
Cocoapods
CocoaPods is a dependency manager for Objective-C and Swift projects. You can install it with the following command:
$ [sudo] gem install cocoapods
CocoaPods 1.5+ is required.
To integrate one or more client libraries into your project using CocoaPods, specify them in your Podfile, providing the version specifier you wish to use. To ensure compatibility when using multiple client libraries in the same project, use the same version specifier for all Azure SDK client libraries within the project:
platform :ios, '12.0'
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
target 'MyTarget' do
pod 'AzureCommunication', '~> 1.0.0-beta.7'
pod 'AzureCommunicationCalling', '~> 1.0.0-beta.7'
...
end
Then, run the following command:
$ pod install
Feedback
If you have a bug or feature request for one of the libraries, please post an issue to GitHub.
Release highlights
1.0.0-beta.7 (Changelog)
Azure Communication Services Calling
New Features
- Added the ability to set the Caller display name when initializing the library.
Key Bug Fixes
- Fixed an issue where
handlePushNotification
did not returnfalse
if the same payload had been processed already. - Improved logging to help identify the source of
hangup
-related issues. - Fixed an issue where the remote participant was still available after hangup/disconnect.
Azure Communication Common
New Features
- 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
- Renamed the type
CommunicationUserCredential
toCommunicationTokenCredential
, as it represents a token. - The protocol
CommunicationTokenCredential
has likewise been renamed toCommunicationTokenCredentialProviding
. - All types that conform to the
CommunicationIdentifier
protocol now use the suffixIdentifier
. For example, thePhoneNumber
type used to represent a phone number identifier is now namedPhoneNumberIdentifier
. - Updated the
CommunicationTokenCredential
initializer that automatically refreshes the token to accept a singleCommunicationTokenRefreshOptions
object instead of multiple parameters.
Need help
- For reference documentation visit the Azure SDK for iOS documentation.
- For tutorials, samples, quick starts and other documentation, visit the Azure SDK for iOS repository.
- File an issue via Github Issues.
- Check previous questions or ask new ones on
StackOverflow using the
azure
andios
tags.
Latest Releases
View all the latest versions of iOS packages here.