DocumentationAPI Reference

Adding the Chat SDK

Adding the Chat SDK

You can add the Chat SDK to your project using one of the following methods:

Adding the SDK with SPM

The Swift Package Manager is a tool for managing the distribution of Swift code. It’s integrated with the Swift build system to automate the process of downloading, compiling, and linking dependencies.

To add the Chat SDK to your project as a dependency:

  1. Follow the Apple documentation on how to add the package to your project.

  2. Paste the Chat SDK package URL, https://github.com/zendesk/chat_sdk_ios, into the Choose repository package search bar.

  3. Use version-based Package Requirements, and set the value to the latest version of the SDK.

Adding the SDK with CocoaPods

CocoaPods is a dependency manager that lets you add third-party frameworks and libraries to projects. For installation instructions, see Install CocoaPods.

If not already done, create a Podfile for your project as follows:

  1. In Terminal, navigate to the top-level folder of your project (the one with the xcodeproj file).

  2. Create a Podfile using the pod init command.

  3. Add the ZendeskChatSDK pod to your Podfile.

    target 'My Sample App' do	pod 'ZendeskChatSDK'end

    If you decide to build your own UI, then you will need to add the ZendeskChatProvidersSDK pod instead.

    target 'My Sample App' do	pod 'ZendeskChatProvidersSDK'end

    Note: If you're using Objective-C, you'll need to include use_frameworks!.

  4. Run the pod install command.

Because your project now contains a dependency managed by CocoaPods, you must open the project in Xcode by double-clicking the .xcworkspace file, not .xcodeproj.

For more information, see Using CocoaPods on cocoapods.org.

Adding the SDK with Carthage

Carthage is a third party dependency manager for iOS applications. For installation and usage instructions, see Installing Carthage in the Carthage readme on Github.

  1. Add the following lines to your Cartfile to import the necessary frameworks for working with the UI we provide:

    github "zendesk/chat_sdk_ios" ~> 5.0.5

    Note: If you decide to build your own UI, you will only need to add the ChatProvidersSDK to your Cartfile.

    github "zendesk/chat_providers_sdk_ios" ~> 5.0.5

  2. Run the carthage update --use-xcframeworks command.

  3. On your target's General tab, drag each of the following frameworks from the Carthage/Build/iOS folder to the Frameworks, Libraries and Embedded Content section and embed the frameworks by selecting Embed & Sign option.

    Note: Your app's build targets must point the FRAMEWORK_SEARCH_PATHS setting to the Carthage/Build/iOS folder.

Adding the SDK manually

  1. Download the following ZIP files:

    # Chat provider layer frameworkhttps://github.com/zendesk/chat_providers_sdk_ios/releases/download/5.0.5/ChatProvidersSDK.xcframework.zip
# Chat UI layer frameworkhttps://github.com/zendesk/chat_sdk_ios/releases/download/5.0.5/ChatSDK.xcframework.zip
# Shared Zendesk UI frameworkshttps://github.com/zendesk/messaging_sdk_ios/releases/download/6.0.3/MessagingSDK.xcframework.ziphttps://github.com/zendesk/messagingapi_sdk_ios/releases/download/6.0.2/MessagingAPI.xcframework.ziphttps://github.com/zendesk/commonui_sdk_ios/releases/download/9.0.3/CommonUISDK.xcframework.ziphttps://github.com/zendesk/sdkconfigurations_sdk_ios/releases/download/4.0.1/SDKConfigurations.xcframework.zip

    Note: If you decide to build your own UI, you will only need to add the ChatProvidersSDK framework.

    https://github.com/zendesk/chat_providers_sdk_ios/releases/download/5.0.5/ChatProvidersSDK.xcframework.zip

    You can also batch download the ZIP files by copying the above list, pasting it into a text file and running the following command:

    wget -i _the_name_of_the_file_you_created_

    Note: You can install the wget tool with Homebrew using brew install wget.

  2. In Xcode, select your project in Project navigator:

  3. In Finder, navigate to where you extracted the SDKs.

  4. Ensure a Frameworks directory exists in the top level of your project directory. Create this directory if it does not exist.

  5. Copy the following items into the Frameworks folder in your project:

    • ChatSDK.xcframework
    • ChatProvidersSDK.xcframework
    • CommonUISDK.xcframework
    • SDKConfigurations.xcframework
    • MessagingSDK.xcframework
    • MessagingAPI.xcframework

  6. Drag the frameworks into the Frameworks, Libraries and Embedded Content section of your project and embed the frameworks by selecting Embed & Sign option.

  7. In Build Settings set the CLANG_ENABLE_MODULES field to YES.