Hero Imaage

Azure Communication UI Mobile Library for iOS

Cocoapods CocoaPods Compatible Cocoapods platforms

Azure Communication UI Mobile Library is an Azure Communication Services capability focused on providing UI components for common business-to-consumer and business-to-business calling interactions.

Getting Started

Get started with Azure Communication Services by using the UI Library to integrate communication experiences into your applications. For detailed instructions to quickly integrate the UI Library functionalities visit the Quick-start Documentation.

Prerequisites

An Azure account with an active subscription. Create an account for free.
A Mac running Xcode, along with a valid developer certificate installed into your Keychain. CocoaPods must also be installed to fetch dependencies.
A deployed Communication Services resource. Create a Communication Services resource.
Azure Communication Services Token. See example.

Installation

Requirements

iOS 13+
Xcode 11+
Swift 5.0+

Using CocoaPods

CocoaPods is a dependency manager for Cocoa projects. To set up with CocoaPods visit their Getting Started Guide. To integrate UI Mobile Library into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'AzureCommunicationUI', '1.0.0-beta.2'

Manual Installation

If you prefer importing Mobile UI Library as an Embedded Framework to your project, please visit our Manual Installation guide.

Quick Sample

Replace <GROUP_CALL_ID> with your group id for your call, <DISPLAY_NAME> with your name, and <USER_ACCESS_TOKEN> with your token.

let callCompositeOptions = CallCompositeOptions()
let callComposite = CallComposite(withOptions: callCompositeOptions)
let communicationTokenCredential = try! CommunicationTokenCredential(token: "<USER_ACCESS_TOKEN>")
let options = GroupCallOptions(credential: communicationTokenCredential,
                               groupId: UUID("<GROUP_CALL_ID>")!,
                               displayName: "<DISPLAY_NAME>")
callComposite.launch(with: options)

For more details on Mobile UI Library functionalities visit the API Reference Documentation.

Contributing to the Library or Sample

Before developing and contributing to Communication Mobile UI Library, check out our making a contribution guide.
Included in this repository is a demo of using Mobile UI Library to start a call. You can find the detail of using and developing the UI Library in the Demo Guide.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments. Also, please check our Contribution Policy.

Community Help and Support

If you find a bug or have a feature request, please raise the issue on GitHub Issues.

Known Issues

Please refer to the wiki for known issues related to the library.