tencent cloud


Last updated: 2024-04-23 17:57:21
    This document describes how to quickly integrate the Tencent Cloud IM SDK (iOS) to your projects.

    Environment Requirements

    Xcode 9.0+.
    iPhone or iPad on iOS 8.0 or above.
    Your project has a valid developer signature.

    Integrating the IM SDK

    You can either automatically integrate the IM SDK using CocoaPods, or manually download the SDK and import it to your current project.

    Automatic loading using CocoaPods

    1. Install CocoaPods

    Enter the following command in the terminal window (you need to install the Ruby environment on your macOS in advance):
    sudo gem install cocoapods

    2. Create a Podfile

    Go to the path where the project is located and run the following command. Then, a Podfile will appear under the project path.
    pod init

    3. Edit the Podfile

    Add the dependency to your Podfile:
    platform :ios, '8.0'
    source 'https://github.com/CocoaPods/Specs.git'
    target 'App' do
    # Add the IM SDK
    pod 'TXIMSDK_Plus_iOS'
    # pod 'TXIMSDK_Plus_iOS_XCFramework'
    # pod 'TXIMSDK_Plus_Swift_iOS_XCFramework'
    # If you need to add the Quic plugin, please uncomment the next line.
    # Note:
    # - This plugin must be used with the TXIMSDK_Plus_iOS or TXIMSDK_Plus_iOS_XCFramework edition of the IM SDK, and the plugin version number must match the IM SDK version number. # - For the TXIMSDK_Plus_Swift_iOS_XCFramework edition, there is no need to add this plugin. If you need to use the Quic feature in this edition, please contact us.
    # pod 'TXIMSDK_Plus_QuicPlugin'

    4. Install the SDK or update the local repository.

    Run the following command in the terminal window to update the local library file and install the TXIMSDK:
    pod install
    Or, run the following command to update the local repository:
    pod update
    After the pod command is executed, an .xcworkspace project file integrated with the SDK will be generated. Double-click this file to open it.
    If the pod search fails, you are advised to update the local repo cache of the pod by running the following commands:
    pod setup
    pod repo update
    rm ~/Library/Caches/CocoaPods/search_index.json
    Quic plugin provides axp-quic multiplexing protocol, which has better weak network resistance and can still provide services even when the network packet loss rate reaches 70%. This plugin is only available on the Chat Ultimate edition, to use it, purchase the Ultimate edition, and for more information, please see Pricing. To ensure proper functionality, please update the client SDK to version 7.7.5282 or higer.
    If you need to use the Quic feature in the Swift edition of the IMSDK, please contact us.
    If you still encounter problems after the above operations, see Xcode 15 FAQs.

    Manual integration

    1. Download the SDK

    Download the latest SDK version from GitHub:
    ImSDK_Plus.framework are the core dynamic library files of the IM SDK.
    Package Name
    IM SDK enhanced edition

    2. Create a project

    Create a project.
    Enter a project name, for example, IMDemo.

    3. Integrate the IM SDK

    Add the dependency library: select Target for IMDemo. On the General panel, add the dependency library under Embedded Binaries and Linked Frameworks and Libraries, select ImSDK_Plus.framework.
    Set link parameters: add -ObjC in Build Setting -> Other Linker Flags.
    For manual integration, you need to change ImSDK_Plus.framework to Embed&Sing in Target -> General -> Frameworks -> Libraries and Embedded Content.
    If you need to add a Quic plugin, please refer to the previous steps and manually download the integrated Quic plugin.

    Referencing the IM SDK

    There are two ways to use the SDK in your project code.

    Method 1

    Choose Xcode -> Build Setting -> Header Search Paths, and set the SDK header file path. In files that require the SDK API, reference the corresponding header file.
    #import "ImSDK_Plus.h"

    Method 2

    In files that require the SDK API, reference the corresponding header file.
    #import <ImSDK_Plus/ImSDK_Plus.h>

    Common Issues During Integration in Xcode 15:

    1. [Xcodeproj] Unknown Object Version (60). (RuntimeError)

    When you use Xcode 15 to create a project to integrate TUIKit, entering pod install may result in this issue. The reason is that an earlier version of CocoaPods is used. The following two solutions are available:
    Solution 1: Change the Project Format version of the Xcode project.
    Solution 2: Upgrade the local version of CocoaPods. The upgrading method is not covered in this document.
    You can enter pod --version in the terminal to check the current version of Pods.

    2. Xcode 15 Developer Sandbox Option Issue

    Sandbox: bash(xxx) deny(1) file-write-create
    When using Xcode 15 to create a project, you may encounter compilation failures due to this option. It is recommended that you disable this option.


    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support