TUIKit is a UI component library built on the Chat SDK. It enables rapid implementation of chat, conversation, search, relationship chain, and group management features through ready-to-use UI components. Message sending and receiving are handled by the TUIChat component. This guide explains how to quickly integrate TUIKit and implement its core features.
Note：
This demo uses TRTC's emoji pack with restricted licensing.
Replace default emoji with your own custom designs, or use emoji packs with proper commercial licensing.
Prerequisites
Flutter version >= 3.29.0, Dart version >= 3.7.0.
Android Studio 2022.3.1 or later, Android Gradle plugin version 7.3.1 or above.
Xcode 12.0 or later.
A valid Tencent Cloud account and Chat Application. Refer to Enable the Service to obtain the following information from the Console:
SDKAppID: The unique identifier for your Chat Application.
SDKSecretKey: The secret key for your Application.
Version Compatibility Notice:
To ensure a stable build environment, strictly follow official compatibility requirements:
For Gradle, Android Gradle Plugin, JDK, and Android Studio compatibility, refer to the Android official documentation: Release Notes.
For Kotlin, Android Gradle Plugin, and Gradle version mapping, refer to the Kotlin official documentation: Kotlin-Gradle Plugin Compatibility.
If Android Studio installs with a higher default JDK version, compilation may fail. We recommend using JDK 17. See: Switching Java Versions
We recommend selecting a version combination that matches your project requirements exactly, following the guidelines above.
Integrate TUIKit
1. If you don't have a Flutter app, refer to the Flutter documentation to quickly create a Flutter application. If you already have a Flutter app, skip this step.
2. Add the following dependencies to your project's root pubspec.yaml file:
tencent_cloud_chat_common: ^4.1.0+1
tencent_cloud_chat_conversation: ^4.1.0
tencent_cloud_chat_message: ^4.1.0+3
tencent_cloud_chat_contact: ^4.1.0
tencent_cloud_chat_sticker: ^4.1.0
tencent_cloud_chat_message_reaction: ^4.1.0
tencent_cloud_chat_text_translate: ^4.1.0
tencent_cloud_chat_sound_to_text: ^4.1.0
3. Configure Permissions
TUIKit requires camera, photo library, audio recording, and network permissions. You must manually declare these permissions in your native files to enable related features.
Android
iOS
Open android/app/src/main/AndroidManifest.xml file, and add the following permissions:
2. Open ios/Runner/info.plist and add permission description keys:
<key>NSCameraUsageDescription</key>
<string>Our app requires access to your camera to enable video calling and capturing photos or videos to share in your conversations.</string>
<key>NSMicrophoneUsageDescription</key>
<string>Our app requires access to your microphone to enable voice and video calling features.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>Our app requires access to your photo library to enable sharing photos, videos, and files in your conversations.</string>
At this point, you have successfully integrated TUIKit into your project. To continue building chat, conversation, and other basic interfaces, refer to the Demo Example.
FAQs
Android Error: Unsupported class file major version 65
Cause:
This error indicates that your project uses an outdated Gradle version or your system has a Java version higher than what the project supports. (Version 65 corresponds to Java 21; each Java version has a unique class file version number.)
