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)

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

Differences Between the Basic Edition and the Enhanced Edition

• SDK added the Enhanced Edition from SDK 5.4. The original edition is called the Basic Edition.
• Both the Basic Edition and Enhanced Edition support V2 APIs. However, the Enhanced Edition no longer supports legacy APIs while the Basic Edition still supports legacy APIs.
• If you have not integrated legacy APIs, we recommend that you directly use V2 APIs and choose the Enhanced Edition SDK.
• If you have integrated legacy APIs, we recommend that you upgrade to V2 APIs and gradually transition to the Enhanced Edition SDK.
• Compared with the Basic Edition, the Enhanced Edition has greatly reduced the SDK size and installation package increment.
• Compared with the Basic Edition, the Enhanced Edition provides more new features.
• Subsequent development of new features will only be supported on the Enhanced Edition. The Basic Edition supports only routine maintenance and fixing of existing problems.
• Enhanced Edition Pro has been released from SDK 6.8 version which supports dual line acceleration on network layer and provides better performance for bad network environment.

Comparison of the SDK sizes

Platform	Item	Basic Edition	Enhanced Edition
Android	aar size	7.8 MB	3.1 MB
iOS	framework size	57.7 MB	11.2 MB

Comparison of the app size increments

Platform	Architecture	Basic Edition	Enhanced Edition
apk increment	armeabi-v7a	3.2 MB	1.1 MB
	arm64-v8a	5.2 MB	1.7 MB
ipa increment	arm64	2.1 MB	1.1 MB

Guidelines for Upgrading IMSDK to V2 APIs

API Upgrade Guidelines

Latest Enhanced Version 7.4.4643 @2023.08.11

SDK

• Support subscribing and unsubscribing users
• Support emoji replies
• Support voice-to-text capability
• Support revoking messages in AVChatRoom
• Support setting global message reception options
• Single forwarded message supports automatic renewal of rich media resources
• Voice and video messages support security strike notifications
• Message revoke supports "revoke reason" + "revoker"
• Fixed the issue of inaccurate read status for the last message in a one-on-one chat session
• Fixed the issue of friend remark information not being cleared in time after deleting a friend
• Optimized handling of SQLite file corruption

TUIKit & Demo

• Support storing conversation group order information in the cloud
• iOS optimized video sending process
• Android fixed the issue of continuous voice messages failing to autoplay
• Android fixed the issue of incorrect time display in the call record list
• Android fixed the issue of overlapping items in the Chat Lite message list

Latest Basic Version 5.1.66 @2021.09.22

Android

• Removed the feature of getting Wi-Fi information.

Feedback

• If you encounter any issue when using TIMSDK, please provide feedback on the problem to us so that we can quickly and effectively locate and solve the issue for you.
• TIMSDK Issue Feedback Guidelines