Getting Started

Starting from version 4.3, the ios sdk is delivered as a binary .xcframework file. The use of xcframework will reduce installation steps and also support the use of same binary even when xcode version changes.

We also include an additional framework as a dependency: Realm. In order to properly install the SDK, you must make sure to import and link both frameworks. XCFrameworks for both realm & sdk is bundled together and can be downloaded from this link:

Download the iOS SDK

Manual Installation

  • Drag EkoChat.xcframework and Realm.xcframework to your project's Embedded Binaries. Make sure that Copy items if needed is selected and click Finish. Also switch the Embed section as Embed & Sign.

Carthage Installation

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate EkoChat, add the following to your Cartfile.

binary "https://github.com/EkoCommunications/EkoMessagingSDK/releases/download/4.3.0/EkoChat.json" ~> 4.x.x

Cocoapod Installation

To integrate EkoChat into your Xcode project using CocoaPods, specify it in your Podfile:

pod 'EkoChat', '4.x.x', :source => "https://github.com/EkoCommunications/EkoMessagingSDK.git"

Migration to XCFramework

Here are the steps to migrate from previous sdk version to use new .xcframework

  1. Remove and unlink EkoChat.framework and Realm.framework from your project.

  2. Remove custom Run Script Phase that is required for the version prior to v4.3. strip-frameworks.sh is no longer required, since .xcframework automatically handles the fat binary issue.

  3. Copy and link EkoChat.xcframework and Realm.xcframework to your project. And set Embed & Sign.

step