Quick start

This doc will guide you to integrate the In-app Chat Kit and start a chat quickly.

Prerequisites

• Go to ZEGOCLOUD Admin Console and do the following:
  1. Create a project, and get the AppID and AppSign of your project.
  2. Subscribe to the In-app Chat service.
     

• Environment-specific requirements:
  • Xcode 13.0 or later
  • An iOS device that is running on iOS 12.0 or later
  • The device is connected to the internet.

Integrate the SDK

Add SDK dependencies (using CocoaPods)

1. Open the Terminal, enter the root directory of the project, and run the following to create a Podfile file.

pod init

2. Open Podfile, add pod 'ZIMKit', and change MyProject to your target name.

target 'MyProject' do
  use_frameworks!
  pod 'ZIMKit'
end

3. Execute pod repo update to update the local index to make sure the latest version of SDK can be installed.

pod repo update

4. Execute pod install to install the SDK.

pod install

Integrate In-app Chat Kit into the project

1. Initialize the In-app Chat Kit.

/// AppDelegate.swift
import UIKit
import ZIMKit

@main
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        let appID: UInt32 = <#your appID#> // The AppID you get from ZEGOCLOUD Admin Console.
        let appSign: String = <#your appSign#> // The AppSign you get from ZEGOCLOUD Admin Console.
        ZIMKit.initWith(appID: appID, appSign: appSign)
    }
}

2. Log in to In-app Chat Kit.

After initializing the In-app Chat Kit, you will need to log in by calling the connectUser: method with your user information.

import UIKit
import ZIMKit

/// your viewController.swift
class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

        let connectUserButton = UIButton(type: .custom)
        connectUserButton.setTitle("Connect User And Show", for: .normal)
        connectUserButton.frame = .init(x: 100, y: 100, width: 250, height: 50)
        connectUserButton.addTarget(self, action: #selector(connectUserAction), for: .touchUpInside)
        connectUserButton.backgroundColor = .orange
        view.addSubview(connectUserButton)

    }

    @objc func connectUserAction(_ sender: Any) {
        // Your ID as a user.
        let userID: String = "<#your userID#>" 
        // Your name as a user.
        let userName: String = "<#your userName#>" 
        // The image you set as the user avatar must be network image. e.g., https://storage.zego.im/IMKit/avatar/avatar-0.png
        let userAvatarUrl: String = "<#your userAvatarUrl#>" 

        ZIMKit.connectUser(userID: userID, userName: userName, avatarUrl: userAvatarUrl) { error in
            //  Display the UI views after connecting the user successfully. 
            if error.code == .success {
                self?.showConversationListVC()
            }  
        }
    }
}

3. Display the conversation component of the In-app Chat Kit.

/// your viewController.swift
func showConversationListVC() {
    let conversationVC = ZIMKitConversationListVC()
    let nav = UINavigationController(rootViewController: conversationVC)
    nav.modalPresentationStyle = .fullScreen
    self.present(nav, animated: true)
}

Configure your project

1. Select the Source Code mode to open the Info.plist file.

2. Add the following to the dict part:

<key>NSMicrophoneUsageDescription</key>
<string>We require microphone access to use zimkit.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>We require photo access to use zimkit.</string>

Ideally, by this point, your app will look like this:

Start a chat

In-app Chat Kit supports the following and this section shows you how to implement those respectively:

import UIKit
import ZIMKit

/// your ViewController.swift
class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

    }

    // Start a 1-on-1 chat after logging in successfully.
    func startOneOnOneChat(userID: String) {
        let messageVC = ZIMKitMessagesListVC(conversationID: userID, type: .peer)
        messageVC.modalPresentationStyle = .fullScreen
        present(messageVC, animated: true)

        // Replace the [present] method with the following code if you already use the Navigation Controller.
        // navigationController?.pushViewController(messageVC, animated: true)
    }
}

import UIKit
import ZIMKit

/// your ViewController.swift
class ViewController1: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

    }

    func createGroupChat(userIDs: [String], groupName: String) {
        ZIMKit.createGroup(with: groupName, inviteUserIDs: userIDs) { [weak self] groupInfo, inviteUserErrors, error in
            if error.code == .success {
                if inviteUserErrors.count > 0 {
                    // Implement the logic for the prompt window based on your business logic when there is a non-existing user ID in the group.

                } else {
                    // Directly enter the chat page when the group chat is created successfully.
                    self?.showGroupMessageListVC(groupID: groupInfo.id)
                }
            } else {
                // Implement the logic for the prompt window based on the returned error info when failing to create a group chat. 

            }
        }
    }

    func showGroupMessageListVC(groupID: String) {
        let messageVC = ZIMKitMessagesListVC(conversationID: groupID, type: .group)
        messageVC.modalPresentationStyle = .fullScreen
        present(messageVC, animated: true)

        // Replace the [present] method with the following code if you already use the Navigation Controller.
        // navigationController?.pushViewController(messageVC, animated: true)
    }
}

import UIKit
import ZIMKit

/// your ViewController.swift
class ViewController1: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()

    }

    func joinGroupChat(_ groupID: String) {
        ZIMKit.joinGroup(by: groupID) { [weak self] groupInfo, error in
            if error.code == .success {
                // Display the group chat page after joining a group chat successfully.
                self?.showGroupMessageListVC(groupID: groupInfo.id)
            }
        }
    }

    func showGroupMessageListVC(groupID: String) {
        let messageVC = ZIMKitMessagesListVC(conversationID: groupID, type: .group)
        messageVC.modalPresentationStyle = .fullScreen
        present(messageVC, animated: true)

        // Replace the [present] method with the following code if you already use the Navigation Controller.
        // navigationController?.pushViewController(messageVC, animated: true)
    }
}

Related guides

Get support

Need help or want to raise your questions? Click the button below to join our Discord community to get quick responses.