AzureCommunicationUIDemoApp

UI Mobile Library Demo App

The sample app is a native iOS application developed using both SwiftUI and UIKit frameworks. It uses the Azure Communication UI library to empower the user experience.

Getting Started

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.
• (Optional) Create Azure Communication Services Token service URL. See example.

Before running the sample for the first time

1. After cloning the Repo in your local environment, cd to the AzureCommunicationUI folder in the root of the project directory.

2. Run pod install, this generates a .xcworkspace file.

3. (Optional) cd to the <project_folder>/AzureCommunicationUI/AzureCommunicationUIDemoApp/Sources folder.

4. (Optional) Run touch EnvConfig.xcconfig via the Command Line.

5. (Optional) Add constants from following list to EnvConfig.xcconfig as the sample app's local configurations.

   • Shared:
     • acsToken: a generated Azure Communication Services token
     • acsTokenUrl: the URL to request Azure Communication Services token (You must use https:/$()/ in the format of URL)
     • displayName: your preferred display name
   • for Calling:
     • expiredAcsToken: an expired Azure Communication Services token for UI testing
     • groupCallId: this a type of UUID used to start and join a meeting for Calling
     • teamsMeetingLink: the URL to a Teams meeting (You must use https:/$()/ in the format of URL) for Calling
     • roomCallId: the generated ID to join a room call meeting
     • roomCallRole: the type of role used to join a room call meeting
     • aadToken: the AAD token for Calling
     • participantMRIs: the MRIs for remote participants to dial
   • for Chat:
     • userId: the ID of the local user for Chat
     • threadId: the ID of chat thread for Chat
     • endpointUrl: the URL of where the chat endpoint should be

   

   Note: The EnvConfig.xcconfig file is created strictly for developers convenience. Those configurations can be input once the AzureCommunicationUIDemoApp is running.

1 to N Calling Push Notifications Setup

1. Follow QuickStart to setup Push Notification Hub for ACS Resource or EventGrid
2. For AzureCommunicationUIDemoApp add Push Notification Capability
3. Add AzureCommunicationUIDemoAppExtensions into Frameworks for AzureCommunicationUIDemoApp
4. Change AzureCommunicationUIDemoApp to profile supporting Push Notification

Run Sample

1. Open AzureCommunicationUI.xcworkspace file generated in the above step.

2. Select AzureCommunicationUIDemoApp scheme and target at any iOS simulator/device.

3. Hit Run or ⌘+R to start running.