Sendbird Desk for iOS sample

Introduction

Built with Sendbird Chat platform, Sendbird Desk is a live chat customer support that offers customer satisfaction through enhanced engagement. Through its integration, Desk SDK for iOS enables you to easily customize your ticketing support system with a UI theme, thereby elevating your overall customers’ experience. For example, you can modify the inbox - a management tool and storage unit for the agents’ and tickets’ conversations - to fit within your color scheme and layout.

More about Sendbird Desk for iOS

Find out more about Sendbird Desk for iOs on Desk for iOS doc. If you need any help in resolving any issues or have questions, visit our community.

Before getting started

This section shows you the prerequisites you need for testing Sendbird Desk for iOS sample app.

Requirements

• iOS 12.0 or later
• Swift 5.0 or later
• Sendbird Chat SDK for iOS 4.19.0+
• Sendbird UIKit SDK for iOS 3.20.0+

Try the sample app using your data

If you would like to customize the sample app for your usage, you can replace the default sample app ID with your ID - which you can obtain by creating your Sendbird application from the dashboard.

Note: After creating the Sendbird application, please be sure to contact sales to enable the Desk menu onto the dashboard. Currently, Sendbird Desk is available only for free-trial or Enterprise plans.

Following the previous instructions will allow you to experience the sample app with your data from the Sendbird application.

Getting started

This section explains how to install Desk SDK for iOS before testing the sample app. If you're familiar with using external libraries or SDKs in your projects, installing the Desk SDK will be an easy and straightforward process.

Install Desk SDK for Quickstart

- CocoaPods

1. Open a terminal window. Navigate to the project directory, and then open the Podfile by running the following command

$ open Podfile

2. Make sure that the Podfile includes the following:

# Uncomment the next line to define a global platform for your project
platform :ios, '12.0'

target 'YOUR_PROJECT' do
    # Uncomment the next line if you're using Swift or would like to use dynamic frameworks
    use_frameworks!
    
    # Pods for YOUR_PROJECT
    # Desk
    pod 'SendBirdDesk'
    # UIKit
    pod 'SendBirdUIKit'

end

3. Run pod install.

4. Open QuickStart.xcworkspace.

Install Desk SDK for iOS

You can install the Desk SDK through either CocoaPods, Carthage or Swift Package Manager.

- CocoaPods

1. Create or edit your Podfile

# Uncomment the next line to define a global platform for your project
platform :ios, '12.0'

target 'YOUR_PROJECT' do
    # Uncomment the next line if you're using Swift or would like to use dynamic frameworks
    use_frameworks!
    
    # Pods for YOUR_PROJECT
    pod 'SendBirdDesk'

end

2. Run pod install.
3. Open QuickStart.xcworkspace.

- Carthage

1. Add SendBirdDesk and SendbirdChatSDK into your Cartfile as below:

github "sendbird/sendbird-desk-ios-framework"
github "sendbird/sendbird-chat-sdk-ios"
github "sendbird/sendbird-uikit-ios"

2. Install the SendBirdDesk framework through Carthage.

$ carthage update --use-xcframeworks

- Swift Package Manager

1. File -> Swift Packages -> Add package dependency...

2. Choose Package Repository as the SendbirdDesk repository with below link:

https://github.com/sendbird/SendBird-Desk-iOS-Framework.git

3. Select Up to Next Major rules and click the Next button to add the package.

For further reference

Please visit the following link to learn more about Desk SDK for iOS: https://github.com/sendbird/SendBird-Desk-iOS-Framework