This document describes how to quickly integrate the Tencent Cloud IM SDK (iOS) into your projects. To configure and integrate the SDK, complete the following steps.
You can automatically integrate the IM SDK by using CocoaPods or manually download the SDK and import it to your current project.
Run the following command in the terminal window (you need to install the Ruby environment on your MacOS device in advance):
sudo gem install cocoapods
Navigate to the path where the project is located and run the following command. Then, a Podfile appears under the project path.
If you are using the standard edition of SDK, edit the Podfile as follows:
platform: ios, '8.0' source 'https://github.com/CocoaPods/Specs.git' target 'App' do pod 'TXIMSDK_iOS' end
If you are using the lite edition of SDK, edit the Podfile as follows:
platform: ios, '8.0' source 'https://github.com/CocoaPods/Specs.git' target 'App' do pod 'TXIMSDK_Smart_iOS' end
Run the following command in the terminal window to update the local library file and install TXIMSDK:
Alternatively, run the following command to update the local library version:
After the pod command is executed, a project file integrated with the SDK and suffixed .xcworkspace appears. Double-click the project file to open it.
If the pod search fails, we recommend that you 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
Download the latest version of the IM SDK from GitHub.
|ImSDK.framework||Standard-edition IM feature pack|
|ImSDK_Smart.framework||Lite-edition IM feature pack|
|TXLiteAVSDK_UGC.framework||Extension pack for recording and editing short videos||This pack provides the short-video recording and editing features. For more information, see UGSV SDK Documentation|
Create a new project.
Enter a project name, for example, IMDemo.
Add the dependent library: select Target for IMDemo. On the General panel, add the dependent library under Embedded Binaries and Linked Frameworks and Libraries. If you are using the standard edition of SDK, select ImSDK.framework. If you are using the lite edition of SDK, select ImSDK_Smart.framework.
Configure link parameters: Choose **Build Setting > Other Linker Flags and add
You can use the SDK in project code in two ways:
Choose Xcode > Build Setting > Header Search Paths and specify the SDK header file path. In files that require the SDK API, reference the corresponding header file.
In files that require the SDK API, reference the corresponding header file.