TIMSDK/README.md

English | 简体中文

Notice: If you open a pull request in TUIKit Android or iOS and the corresponding changes are successfully merged, your name will be included in README.md with a hyperlink to your homepage on GitHub.

Instant Messaging

Product Introduction

Build real-time social messaging capabilities with all the features into your applications and websites based on powerful and feature-rich chat APIs, SDKs and UIKit components.

Android Experience App	iOS Experience App

TUIKit is a UI component library based on Tencent Cloud IM SDK. It provides universal UI components to offer features such as conversation, chat, search, relationship chain, group, and audio/video call features.

Image Download

Tencent Cloud branch download address: Download

SDK Download

Native SDK	Download Address	Integration Guide	Update Log
Android	GitHub (Recommended)	[Quick Integration] TUIKit Integration (Android) [General Integration] SDK Integration (Android)	Update Log (Native)
iOS	GitHub (Recommended)	[Quick Integration] TUIKit Integration (iOS) [General Integration] SDK Integration (iOS)
Mac	GitHub (Recommended)	[General Integration] SDK Integration (Mac)
Windows	GitHub (Recommended)	[General Integration] SDK Integration (Windows)
HarmonyOS	GitHub (Recommended)	[General Integration] SDK Integration (HarmonyOS)

TUIKit Integration

Functional Module	Platform	Document Link
TUIKit Library	iOS	TUIKit-iOS Library
	Android	TUIKit-Android Library
Quick Integration	iOS	TUIKit-iOS Quick Integration
	Android	TUIKit-Android Quick Integration
Modifying UI Themes	iOS	TUIKit-iOS Modifying UI Themes
	Android	TUIKit-Android Modifying UI Themes
Setting UI Styles	iOS	TUIKit-iOS Setting UI Styles
	Android	TUIKit-Android Setting UI Styles
Adding Custom Messages	iOS	TUIKit-iOS Adding Custom Messages
	Android	TUIKit-Android Adding Custom Messages
Implementing Local Search	iOS	TUIKit-iOS Implementing Local Search
	Android	TUIKit-Android Implementing Local Search
Integrating Offline Push	iOS	TUIKit-iOS Integrating Offline Push
	Android	TUIKit-Android Integrating Offline Push

Guidelines for Upgrading IMSDK to V2 APIs

API Upgrade Guidelines

Latest Enhanced Version 8.4.6667 @2025.01.15

SDK

• Support searching for group data in the cloud.
• Support searching for user data in the cloud.
• Support searching for group member data in the cloud.
• The community supports setting private topics.
• Pure push messages support offline storage.
• Honor's offline push supports message categorization.
• iOS offline push supports background silent push.
• iOS push supports setting the interruption level.
• Self-developed high-performance and highly reliable local KV component.
• Optimize the local cache policy of the log module.
• IMSDK supports blocking Tencent package names.
• Upgrade the SSO connection IP address of the India site.
• Support SSO to configure the long - polling interval of live broadcast group owners.
• Optimize the topic data pulling logic and directly return when there is no network connection.
• Fix an occasional failure in sending @messages to all members in a group by the HarmonyOS SDK.
• Fix an occasional failure in setting global message Do - Not - Disturb by the HarmonyOS SDK.

Note:

Local sensitive word detection is no longer supported.

TUIKit & Demo

• TUIKit removes the TUIGroup component.