Avaya Client SDK

< Back to Package Overview

My First Project For Avaya Aura® Infrastructure

If you are new to iOS development, start by creating the AppleID then install the Xcode from Apple App Store. The XCode is free. The Sample App that is provided with this documentation has been built and tested using Xcode, Apple's standard development environment for iOS.

Running the Sample App for the first time

The Communications package Sample App for iOS has been designed for and complied on Xcode 12.4 or later. You can check XCode version by XCode > About Xcode menu item.

About Xcode

Once you have Xcode installed on your Mac, follow steps below to build and run iOS Communication Package Sample Application on actual iOS device or using iOS simulator (which comes along with Xcode).

  1. Open the sample project in Xcode through File > Open menu item. Select following project file.
    CommunicationPackage/sample/CommunicationSampleApp.xcodeproj
  2. Build can be executed in two different ways:
    • If you use iPhone Simulator, copy folders
      CommunicationPackage/sdk/iphonesimulator/AvayaClientServices.framework
      CommunicationPackage/sdk/iphonesimulator/AvayaClientMedia.framework
      CommunicationPackage/sdk/iphonesimulator/RVVideoCodec.framework
      to CommunicationPackage/sdk/ and select targeted simulator as "iPhone5s" preferably.
    • If you use physical iPhone device, copy folders
      CommunicationPackage/sdk/iphoneos/AvayaClientServices.framework
      CommunicationPackage/sdk/iphoneos/AvayaClientMedia.framework
      CommunicationPackage/sdk/iphoneos/RVVideoCodec.framework
      to CommunicationPackage/sdk/ and select targeted as "<connected_iPhone>" preferably.
  3. Now you have Sample Application Project ready for build and execution. Select Product > Build menu item. Make sure that your application builds successfully.
  4. Click on Run for running Sample Apps to confirm that your development environment and test device is setup correctly.

Build for iOS

Note: Due to media requirements for features provided within the Communications Package for iOS, developers must use a physical device rather than an emulator for development.

Configure services and start working with features

Once you have completed setup of your development environment and have confirmed the Sample App runs on your device, you are now ready to configure services and start using working with features. The Communications SDK for iOS can be used in a number of different product environments.

These articles will walk you through the information needed for each SDK service and where to get that information...

What to do next...

With the Sample App running on your device and your service configuration details in hand, you are now ready to begin the process of learning how to integrate communications features using the Communications Package for iOS into your application.

The following is a recommended list of articles to get you started: