tencent cloud

Feedback

Last updated: 2024-05-20 16:59:17

    Applicable Scenario

    TUIChat offers both private chat (1V1) and group chat (Group) features, supporting multiple operations on messages, such as sending different types of messages, long pressing a message to like/reply/quote, and querying message read receipt details.
    You can integrate TUIChat into your app alone. The chat interface has a wide range of usage scenarios, such as real estate agency consultation, online medical consultation, e-commerce online customer service, and remote loss assessment for insurance.
    The UI effect is as shown below:
    Minimalist
    RTL Language
    Classic
    Message Interface | Sending Multiple Types of Messages
    
    Message Like/Reply/Quote | Message Reply Details
    
    Message Reply Details | Read Receipt Details
    
    Message Interface | Sending Multiple Types of Messages
    
    Message Like | Reply
    
    Message Read Receipt | Read Receipt Details
    
    Message Interface
    Sending Multiple Types of Messages
    
    
    Message Like
    Reply
    
    
    Message Read Receipt
    Read Receipt Details
    
    

    Development Environment Requirements

    Xcode 10 and later
    iOS 9.0 and later

    Integrating TUIChat Source Code via Pod

    We offer two Podfile integration methods: Pulling from remote CocoaPods (Method 1) and Development Pods for local integration (Method 2), with their advantages and disadvantages as follows:
    Pulling from remote CocoaPods (Method 1) is suitable for integration without source code modifications:
    Advantages: When there's a TUIChat version update, you only need to run Pod update again to complete the update.
    Disadvantages: If you have made modifications to the source code, using Pod update to update will result in the new version of TUIChat overwriting your modifications.
    Development Pods for local integration (Method 2) is suitable for users who need to customize the modification of source code:
    Advantages: When you have your own git repository, you can track modifications. Furthermore, after modifying the source code, using Pod update to update (other non-local integrated Pods) will not overwrite your modifications.
    Disadvantages: You need to manually override your local TUIChat folder with the TUIChat source code for updates.

    Method 1: Pulling from Remote CocoaPods Integration (Recommended When There Are No Source Code Modifications)

    Minimalist
    Classic
    # Uncomment the next line to define a global platform for your project.
    source 'https://github.com/CocoaPods/Specs.git'
    platform :ios, '13.0'
    # Prevent `*.xcassets` in TUIChat components from conflicting with your project.
    install! 'cocoapods', :disable_input_output_paths => true
    
    # Replace `your_project_name` with your actual project name.
    target 'your_project_name' do
    use_frameworks!
    
    # Enable modular headers as needed. Only after you enable modular headers, the Pod module can be imported using @import.
    # use_modular_headers!
    
    # Integrate the chat feature.
    pod 'TUIChat/UI_Minimalist'
    end
    
    #Pods config
    post_install do |installer|
    installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
    #Fix Xcode14 Bundle target error
    config.build_settings['EXPANDED_CODE_SIGN_IDENTITY'] = ""
    config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
    config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
    config.build_settings['ENABLE_BITCODE'] = "NO"
    config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
    #Fix Xcode15 other links flag -ld64
    xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
    if xcode_version >= 15
    xcconfig_path = config.base_configuration_reference.real_path
    xcconfig = File.read(xcconfig_path)
    if xcconfig.include?("OTHER_LDFLAGS") == false
    xcconfig = xcconfig + "\\n" + 'OTHER_LDFLAGS = $(inherited) "-ld64"'
    else
    if xcconfig.include?("OTHER_LDFLAGS = $(inherited)") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS", "OTHER_LDFLAGS = $(inherited)")
    end
    if xcconfig.include?("-ld64") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS = $(inherited)", 'OTHER_LDFLAGS = $(inherited) "-ld64"')
    end
    end
    File.open(xcconfig_path, "w") { |file| file << xcconfig }
    end
    end
    end
    end
    
    # Uncomment the next line to define a global platform for your project.
    source 'https://github.com/CocoaPods/Specs.git'
    # Prevent `*.xcassets` in TUIChat components from conflicting with your project.
    install! 'cocoapods', :disable_input_output_paths => true
    
    # Replace your_project_name with your actual project name.
    target 'your_project_name' do
    use_frameworks!
    
    # Enable modular headers as needed. Only after you enable modular headers, the Pod module can be imported using @import.
    # use_modular_headers!
    # Integrate the chat feature.
    pod 'TUIChat/UI_Classic'
    end
    
    #Pods config
    post_install do |installer|
    installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
    #Fix Xcode14 Bundle target error
    config.build_settings['EXPANDED_CODE_SIGN_IDENTITY'] = ""
    config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
    config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
    config.build_settings['ENABLE_BITCODE'] = "NO"
    config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
    #Fix Xcode15 other links flag -ld64
    xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
    if xcode_version >= 15
    xcconfig_path = config.base_configuration_reference.real_path
    xcconfig = File.read(xcconfig_path)
    if xcconfig.include?("OTHER_LDFLAGS") == false
    xcconfig = xcconfig + "\\n" + 'OTHER_LDFLAGS = $(inherited) "-ld64"'
    else
    if xcconfig.include?("OTHER_LDFLAGS = $(inherited)") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS", "OTHER_LDFLAGS = $(inherited)")
    end
    if xcconfig.include?("-ld64") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS = $(inherited)", 'OTHER_LDFLAGS = $(inherited) "-ld64"')
    end
    end
    File.open(xcconfig_path, "w") { |file| file << xcconfig }
    end
    end
    end
    end
    Note:
    If you directly pod 'TUIChat' without specifying the classic or the minimalist version, it will integrate two sets of UI components by default.
    If you are using Swift, enable use_modular_headers! and change the reference of the header file to the reference format of @import module name.
    Run the following command to install the TUIChat component.
    pod install
    If you cannot install the latest version of TUIChat, run the following command to update the local CocoaPods repository list.
    pod repo update
    Then, run the following command to update the Pod version of the component library.
    pod update
    After integrating TUIChat components, the project structure is as follows:
    
    Note:
    If you encounter any errors during the operation, you can refer to the FAQs at the end of the document.

    Method 2: Development Pods Local Integration (Recommended When Modifying Source Code)

    1. Download TUIChat source code from GitHub. Drag it directly into your project directory, such as: TestTUIKitIM/TUIKit/TUIChat.
    
    2. Modify the local path of each component in your Podfile, changing the path to the path of the TUIChat folder relative to your project's Podfile.
    For example, in the Demo: pod 'TUIChat', :path => "./TUIKit/TUIChat"
    Note:
    In the above example, the TUIChat folder is located in a subdirectory of TUIKit, at which point we use pod 'TUIChat', :path => "./TUIKit/TUIChat"
    The representation of other relative paths is as follows:
    Parent Directory: pod 'TUIChat', :path => "../TUIKit/TUIChat"
    Current Directory: pod 'TUIChat', :path => "/TUIKit/TUIChat"
    Subdirectory: pod 'TUIChat', :path => "./TUIKit/TUIChat"
    3. After modification, run pod update.
    Development Podfile
    # Uncomment the next line to define a global platform for your project.
    source 'https://github.com/CocoaPods/Specs.git'
    platform :ios, '13.0'
    install! 'cocoapods', :disable_input_output_paths => true
    
    # Replace `your_project_name` with your actual project name.
    target 'your_project_name' do
    # Uncomment the next line if you're using Swift or would like to use dynamic frameworks.
    use_frameworks!
    use_modular_headers!
    
    # Note: When using the local integration solution, upgrade by downloading the latest component code from https://github.com/TencentCloud/TIMSDK/tree/master/iOS/TUIKit/TUIChat
    # and placing it in the designated local directory, such as /TIMSDK/ios/TUIKit/TUIChat
    # Note: When private modifications conflict with remote changes, manual merging is required to resolve conflicts.
    # Integrate the basic library (required).
    pod 'TUICore', :path => "../TUIKit/TUICore"
    pod 'TIMCommon', :path => "../TUIKit/TIMCommon"
    # Integrate the chat feature.
    pod 'TUIChat', :path => "../TUIKit/TUIChat"
    
    # Other Pod
    pod 'MJRefresh'
    pod 'Masonry'
    end
    
    #Pods config
    post_install do |installer|
    installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
    #Fix Xcode14 Bundle target error
    config.build_settings['EXPANDED_CODE_SIGN_IDENTITY'] = ""
    config.build_settings['CODE_SIGNING_REQUIRED'] = "NO"
    config.build_settings['CODE_SIGNING_ALLOWED'] = "NO"
    config.build_settings['ENABLE_BITCODE'] = "NO"
    config.build_settings['IPHONEOS_DEPLOYMENT_TARGET'] = "13.0"
    #Fix Xcode15 other links flag -ld64
    xcode_version = `xcrun xcodebuild -version | grep Xcode | cut -d' ' -f2`.to_f
    if xcode_version >= 15
    xcconfig_path = config.base_configuration_reference.real_path
    xcconfig = File.read(xcconfig_path)
    if xcconfig.include?("OTHER_LDFLAGS") == false
    xcconfig = xcconfig + "\\n" + 'OTHER_LDFLAGS = $(inherited) "-ld64"'
    else
    if xcconfig.include?("OTHER_LDFLAGS = $(inherited)") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS", "OTHER_LDFLAGS = $(inherited)")
    end
    if xcconfig.include?("-ld64") == false
    xcconfig = xcconfig.sub("OTHER_LDFLAGS = $(inherited)", 'OTHER_LDFLAGS = $(inherited) "-ld64"')
    end
    end
    File.open(xcconfig_path, "w") { |file| file << xcconfig }
    end
    end
    end
    end
    Note:
    When using the local integration solution and needing an upgrade, go to Github-TUIChat for updates.
    Download the latest component code and overwrite the local directory, e.g., TIMSDK/iOS/TUIKit/TUIChat.
    When private modifications conflict with remote changes, manual merging is required to resolve conflicts.
    The TUIChat plugin requires a TUICore-dependent version. Ensure the plugin version matches the spec.version in "../TUIKit/TUICore/TUICore.spec".
    If you encounter any errors during the operation, refer to the FAQs at the end of the document.

    Component Login

    The TUIChat component can be used normally only after logging in the chat feature successfully.
    SDKAppID needs to be created and obtained in the Chat Console, and userSig needs to be calculated according to the rules. For detailed steps, refer to the document Run the Demo.
    The sample code is as follows:
    #import "TUILogin.h"
    
    - (void)loginSDK:(NSString *)userID userSig:(NSString *)sig succ:(TSucc)succ fail:(TFail)fail {
    [TUILogin login:SDKAppID userID:userID userSig:sig succ:^{
    NSLog(@"login succeeded");
    } fail:^(int code, NSString *msg) {
    NSLog(@"login failed");
    }];
    }

    Navigating to the Chat Interface

    You can directly navigate from your App interface to the TUIChat Chat Interface. When initializing the chat interface, you need to pass in the conversation information corresponding to the current chat interface.
    The sample code is as follows:
    Minimalist
    Classic
    // For 1v1 conversations, only pass userID. For group conversations, only pass groupID.
    - (void)pushToChatViewController:(NSString *)groupID userID:(NSString *)userID {
    // Create conversation information
    TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];
    conversationData.userID = userID;
    conversationData.groupID = groupID;
    // Create chatVC
    TUIBaseChatViewController_Minimalist *chatVC = nil;
    if (conversationData.userID.length > 0) {
    chatVC = [[TUIC2CChatViewController_Minimalist alloc] init];
    } else if (conversationData.groupID.length > 0) {
    chatVC = [[TUIGroupChatViewController_Minimalist alloc] init];
    }
    chatVC.conversationData = conversationData;
    [self.navigationController pushViewController:chatVC animated:YES];
    }
    
    // For 1v1 session, only pass userID. For group conversations, only pass groupID.
    - (void)pushToChatViewController:(NSString *)groupID userID:(NSString *)userID {
    // Create conversation information
    TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];
    conversationData.userID = userID;
    conversationData.groupID = groupID;
    // Create chatVC
    TUIBaseChatViewController *chatVC = nil;
    if (conversationData.userID.length > 0) {
    chatVC = [[TUIC2CChatViewController alloc] init];
    } else if (conversationData.groupID.length > 0) {
    chatVC = [[TUIGroupChatViewController alloc] init];
    }
    chatVC.conversationData = conversationData;
    [self.navigationController pushViewController:chatVC animated:YES];
    }

    Integrating the Chat Window into Your Own Page

    You can also embed the TUIChat chat interface into your controller's View.
    The sample code is as follows:
    Minimalist
    Classic
    #import "TUIC2CChatViewController_Minimalist.h"
    #import "TUIGroupChatViewController_Minimalist.h"
    
    // ChatViewController is your own ViewController
    @implementation ChatViewController
    - (void)viewDidLoad {
    // Create conversation information
    TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];
    // For a 1v1 Chat, only pass userID. For a group Chat, only pass groupID.
    conversationData.userID = @"userID";
    conversationData.groupID = @"groupID";
    // Create chatVC
    TUIBaseChatViewController_Minimalist *chatVC = nil;
    if (conversationData.groupID.length > 0) {
    chatVC = [[TUIGroupChatViewController_Minimalist alloc] init];
    } else if (conversationData.userID.length > 0) {
    chatVC = [[TUIC2CChatViewController_Minimalist alloc] init];
    }
    [chatVC setConversationData:conversationData];
    // Add chatVC to your own ViewController
    [self addChildViewController:vc];
    [self.view addSubview:vc.view];
    }
    @end
    
    
    #import "TUIC2CChatViewController.h"
    #import "TUIGroupChatViewController.h"
    
    // ChatViewController is your own ViewController
    @implementation ChatViewController
    - (void)viewDidLoad {
    // Create conversation information
    TUIChatConversationModel *conversationData = [[TUIChatConversationModel alloc] init];
    // For a 1v1 Chat, only pass userID. For a group Chat, only pass groupID.
    conversationData.userID = @"userID";
    conversationData.groupID = @"groupID";
    // Create chatVC
    TUIBaseChatViewController *chatVC = nil;
    if (conversationData.groupID.length > 0) {
    chatVC = [[TUIGroupChatViewController alloc] init];
    } else if (conversationData.userID.length > 0) {
    chatVC = [[TUIC2CChatViewController alloc] init];
    }
    [chatVC setConversationData:conversationData];
    // Add chatVC to your own ViewController
    [self addChildViewController:vc];
    [self.view addSubview:vc.view];
    }
    @end

    FAQs

    Common Issues for Launching

    Packaging fails when launching an app on the Appstore, showing an Unsupported Architectures error.
    The issue is as shown in the following image. Packaging indicates that the ImSDK_Plus.framework includes an x86_64 simulator version not supported by the Appstore. This problem arises because Chat SDK, for the convenience of developers, includes the simulator version by default in its releases.
    
    You can follow the steps below to remove the simulator version upon packaging:
    1.1 Select your project's Target, and click on the Build Phases option, then add a Run Script in the current panel.
    
    In the newly added Run Script, include the following script:
    #!/bin/sh
    
    # Strip invalid architectures
    strip_invalid_archs() {
    binary="$1"
    echo "current binary ${binary}"
    # Get architectures for current file
    archs="$(lipo -info "$binary" | rev | cut -d ':' -f1 | rev)"
    stripped=""
    for arch in $archs; do
    if ! [[ "${ARCHS}" == *"$arch"* ]]; then
    if [ -f "$binary" ]; then
    # Strip non-valid architectures in-place
    lipo -remove "$arch" -output "$binary" "$binary" || exit 1
    stripped="$stripped $arch"
    fi
    fi
    done
    if [[ "$stripped" ]]; then
    echo "Stripped $binary of architectures:$stripped"
    fi
    }
    
    APP_PATH="${TARGET_BUILD_DIR}/${WRAPPER_NAME}"
    
    # This script loops through the frameworks embedded in the application and
    # removes unused architectures.
    find "$APP_PATH" -name '*.framework' -type d | while read -r FRAMEWORK
    do
    FRAMEWORK_EXECUTABLE_NAME=$(defaults read "$FRAMEWORK/Info.plist" CFBundleExecutable)
    FRAMEWORK_EXECUTABLE_PATH="$FRAMEWORK/$FRAMEWORK_EXECUTABLE_NAME"
    echo "Executable is $FRAMEWORK_EXECUTABLE_PATH"
    strip_invalid_archs "$FRAMEWORK_EXECUTABLE_PATH"
    done
    

    Common Issues with Xcode 15 Integration

    [Xcodeproj] Unknown object version (60). (RuntimeError)
    
    When using Xcode 15 to create a new project for integrating TUIKit, entering pod install may lead to this issue. The reason is the use of an older version of CocoaPods. In this case, there are two solutions:
    Solution one: Modify the Project Format version of the Xcode project.
    
    Solution two: 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.
    -ld64 Linker Issues
    Assertion failed: (false && "compact unwind compressed function offset doesn't fit in 24 bits"), function operator(), file Layout.cpp
    
    Or when integrating TUIRoom with XCode 15, if the latest linker causes symbol conflicts with TUIRoomEngine, it is related to this issue.
    
    Resolution: Modify linker configuration
    Add "-ld64" to Other Linker Flags in Build Settings to resolve the issue. For more details, refer to This Document.
    
    Rosetta Simulator Issues
    When using Apple Silicon (m1/m2 etc. series chips), an issue occurs because libraries including SDWebImage do not support xcframework. However, Apple still provides a workaround by enabling Rosetta settings on the simulator. Generally, the Rosetta option will pop up automatically during compilation.
    
    Xcode 15 Developer Sandbox Option Issues
    Sandbox: bash(xxx) deny(1) file-write-create
    
    When creating a new project with Xcode 15, you may encounter compilation failures due to this option. It is recommended to disable this option.
    

    Common Issues with CocoaPods Integration

    Issues with Pod Dependency Version Mismatch during Remote Integration
    If you encounter a mismatch between Podfile.lock and the plugin-dependent version of TUICore while using remote Pods integration,
    Delete the Podfile.lock file at this time, and use pod repo update to update the local code repository, then use pod update to update again.
    
    Issues with Pod Dependency Version Mismatch during Local Integration
    When integrating with DevelopPods and the plugin-dependent TUICore version is newer, but the local Pod depends on version number 1.0.0,
    refer to Podfile_local and TUICore.spec. The plugin needs to follow the version and be consistent with TUICore.spec. Normally, we will help you modify it to be consistent.
    When using local integration for the first time, it is recommended that you download our sample Demo project, replace the content of the Podfile with that of Podfile_local, and execute Pod update for cross-reference.
    
    
    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