# Tencent RTC Chat — React Native > Chat documentation for React Native platform. ## UIKit ### Getting Started - [Activate the Service](https://pre.trtc.io/document/74511.md): Tencent Cloud Chat service is an instant messaging SDK that enables developers to integrate messaging and group management features. This guide helps users activate the free plan, retrieve UserSig for authentication, purchase official editions, renew subscriptions, upgrade plans, and enable automatic renewal. It provides step-by-step instructions to quickly start using Chat and manage your application versions effectively. - [Run Demo](https://pre.trtc.io/document/52397.md): TUIKit is a React Native UI component library built on Tencent Cloud Chat SDK, designed to help developers quickly create chat applications with conversation, chat, and group features. This quickstart guide covers prerequisites, environment setup, demo download and configuration, running the demo on Android and iOS devices, and sending your first message. It also includes solutions for common environment and build issues to ensure smooth development. - [Integration](https://pre.trtc.io/document/56573.md): TUIKit is a React Native UI component library under Tencent Cloud Chat SDK that helps developers quickly build chat applications with session, chat, and group features. This quickstart guide walks through creating a React Native project with Expo, integrating TUIKit, configuring necessary permissions for iOS and Android, importing components, and testing the chat functionality. It supports internationalization and is optimized for overseas user experience. ### Features - [Quote Reply](https://pre.trtc.io/document/66966.md): The React Native TUIChat SDK provides a message quoting feature that allows users to reply to specific messages by quoting them. This feature enables users to long press a message to quote it, cancel quoting before sending, and view quoted messages by clicking the citation to jump to and highlight the original message. It enhances conversation clarity and navigation within chat sessions. - [Manufacturer configuration](https://pre.trtc.io/document/67583.md) - [Quick Integration](https://pre.trtc.io/document/67584.md) - [Client APIs](https://pre.trtc.io/document/67585.md) ### Customization - [Localization](https://pre.trtc.io/document/67279.md): React Native Chat UIKit offers default English and Simplified Chinese language packs and supports customizable internationalization. This guide explains how to initialize language resources, switch languages dynamically, add new language packs, update translation content, and use the translation API to localize app interfaces effectively. ## Core SDK ### Getting Started - [Activate the Service](https://pre.trtc.io/document/74511.md): Tencent Cloud Chat service is an instant messaging SDK that enables developers to integrate messaging and group management features. This guide helps users activate the free plan, retrieve UserSig for authentication, purchase official editions, renew subscriptions, upgrade plans, and enable automatic renewal. It provides step-by-step instructions to quickly start using Chat and manage your application versions effectively. - [Run Demo](https://pre.trtc.io/document/66946.md): The React Native SDK is a chat integration npm package that enables developers to quickly implement chat features in their applications using Tencent Cloud Chat API. This guide covers essential steps including initializing the chat instance, sending messages, managing conversations, updating user profiles, creating groups, and following users. It provides a practical introduction to using the SDK with React Native and other frontend frameworks to build versatile chat applications. - [Install Chat SDK](https://pre.trtc.io/document/48865.md): Tencent Cloud Chat SDK is a chat SDK for React Native that enables developers to integrate real-time messaging features into their applications. This guide covers environment setup, project creation, SDK initialization, event handling, and plugin integration for Android and iOS platforms. Follow these steps to quickly integrate the Tencent Cloud Chat SDK and enhance your app's messaging capabilities. - [Initialize Chat SDK](https://pre.trtc.io/document/48866.md): The React Native Chat SDK is a software development kit that enables chat functionalities for React Native applications. This quickstart guide is designed for developers who want to integrate Tencent Cloud Chat into their apps. It covers essential steps including preparing an SDKAppID, initializing the SDK with TencentCloudChat.create, and setting up event listeners to handle chat events effectively. - [Login and Logout](https://pre.trtc.io/document/48867.md): Tencent Chat SDK React Native API provides methods for user login, logout, retrieving login user information, checking SDK readiness, and obtaining server time. It requires UserID and UserSig for secure authentication and supports multi-instance login configuration. Developers must listen for SDK readiness events before invoking authenticated APIs to ensure proper session management and message handling. ### Users - [User Profile](https://pre.trtc.io/document/48860.md): Tencent Cloud Chat SDK for React Native provides APIs for managing user profiles, including querying your own profile, retrieving other users' profiles, and updating personal profile information such as nickname, avatar, gender, and custom fields. These APIs support asynchronous operations via Promises and enable developers to integrate comprehensive user profile features into their React Native applications. - [User Online Status](https://pre.trtc.io/document/66156.md): The React Native SDK offers a User Status Management API that allows developers to handle both built-in normal statuses and client-defined custom statuses for users. It supports setting custom statuses, querying user statuses, and receiving real-time notifications of status changes. This SDK is designed for applications requiring user presence and status synchronization across multiple devices and platforms. - [Friend Management](https://pre.trtc.io/document/49564.md): The Chat SDK for React Native provides friend management capabilities including adding, deleting, and managing friends. This guide helps developers integrate friend-related features such as getting contacts, sending friend requests, accepting or refusing requests, and enforcing messaging restrictions to only friends. Key steps include using APIs like getFriendList, addFriend, and deleteFriend to implement friend operations efficiently. - [Friend List](https://pre.trtc.io/document/49566.md): Tencent Cloud Chat React Native SDK provides APIs to manage friend groups, including creating, deleting, renaming groups, and adding or removing friends from groups. These APIs enable developers to categorize friends into custom groups such as "Classmates" or "Coworkers". The SDK supports event notifications for friend group updates, facilitating real-time synchronization in chat applications. - [Block List](https://pre.trtc.io/document/49568.md): The React Native Chat SDK provides APIs to manage user blocking and blacklists, enabling developers to block or unblock users, retrieve the current blocklist, and receive notifications when the blocklist changes. This functionality helps control message reception and friend relationships by limiting interactions with blocked users. The blocklist supports up to 1000 users and includes methods such as addToBlacklist, removeFromBlacklist, getBlacklist, and event handling for blacklist updates. - [Follow](https://pre.trtc.io/document/66157.md): The React Native Following Feature API provides SDK methods to manage user follow relationships, including following and unfollowing users, retrieving followers, following, and mutual followers lists with pagination support. These APIs enable developers to build interactive social features that allow users to stay updated with content from users they follow. The feature supports batch operations for up to 20 users and returns up to 500 users per request for list retrievals. ### Group Channels - [Overview](https://pre.trtc.io/document/48169.md): The Chat SDK offers various group types including work groups, public groups, meeting groups, communities, and audio-video groups to support diverse chat scenarios. This overview explains the capabilities and limits of each group type, such as member roles, join approvals, and message history management. It also highlights the requirements for using community groups and configuration options for enabling message history retrieval. The Chat SDK is designed for developers to implement flexible and scalable group communication features. - [Group Channel Settings](https://pre.trtc.io/document/50404.md): TencentCloudChat group management SDK for React Native enables developers to create, search, join, leave, and disband groups. It supports multiple group types including work, public, meeting, audio-video, and community groups, with customizable membership and invitation options. This API reference details key methods and parameters for managing group lifecycle and events in real-time communication applications. - [Group Channel Profile](https://pre.trtc.io/document/50405.md): The React Native Chat SDK provides APIs to get and update group profile information, including custom fields, group name, avatar, introduction, notification, and membership settings. These APIs enable developers to retrieve detailed group data and modify group attributes such as muting members or setting join and invite options. This reference is intended for developers integrating group management features in React Native applications using Tencent RTC chat services. - [Member Management (Mute & Ban)](https://pre.trtc.io/document/50406.md): The React Native SDK provides group member management APIs including getGroupMemberList, which retrieves group member information with pagination and role filtering. It supports muting status, online member lists, and special features for AVChatRoom in Pro, Pro Plus, or Enterprise editions. This API is designed for developers managing group members in real-time communication scenarios. - [Member Profile](https://pre.trtc.io/document/50407.md): TencentCloudChat React Native SDK provides APIs to manage group member profiles including retrieving profiles, setting name cards, customizing member fields, and marking members. These APIs support group management tasks with role-based permissions and handle up to 50 users per query. AVChatRoom groups have limited support for these operations. - [Group Channel Attributes](https://pre.trtc.io/document/50408.md): React Native group attributes API provides SDK methods to manage audio chat room seats by setting, deleting, and retrieving group attributes. It supports initializing group attributes, updating them with concurrency control, and listening for attribute update events. This API is designed for developers managing user mic status and seat information in audio chat rooms within Tencent RTC. - [Group Channel Counter](https://pre.trtc.io/document/66155.md): The Chat SDK group counter feature allows developers to set and manage integer-type counters for groups, such as viewer counts, likes, and gifts. It supports up to 20 counters per group and is available for all group types except topic-enabled community groups. This feature is designed for developers using the Premium edition of the Chat SDK to enhance group-related data tracking and interaction. ### Community Channels - [Manage Community](https://pre.trtc.io/document/50292.md): The React Native Chat SDK provides APIs for managing community groups and topics within Tencent Cloud Chat. It enables developers to create topic-enabled communities, manage topics including creation, deletion, and modification, and retrieve community and topic lists. This reference is designed for developers building interactive community features in React Native applications using Tencent Cloud Chat services. ### Messages - [Overview](https://pre.trtc.io/document/48868.md): The Message class in the Chat SDK for React Native defines message objects with detailed attributes such as type, content payload, sender and receiver IDs, conversation type, status, priority, and read receipt information. This API reference helps developers understand how to handle various message types including text, image, audio, video, file, and custom messages within one-to-one, group, and system conversations. - [Send a Message](https://pre.trtc.io/document/48870.md): React Native chat message creation APIs provide methods to create various message types including text, @mention, image, audio, video, custom, emoji, file, location, and merged messages. These APIs return message instances that can be sent via the sendMessage API, enabling developers to implement rich messaging features in React Native applications. The guide details parameters, usage examples, and special features such as targeted group messaging and message priority handling. - [Receive a Message](https://pre.trtc.io/document/51286.md): TencentCloudChat SDK for React Native enables developers to listen for and handle MESSAGE_RECEIVED events to receive various types of messages. This API reference explains how to register and unregister event handlers before login to ensure no events are missed. Supported message types include text, image, audio, video, file, custom, merged, location, group tip, and group system notifications. - [Message History](https://pre.trtc.io/document/48872.md): The React Native Chat SDK provides APIs to pull historical messages by page, sequence, or time range. It supports multiple editions with different free storage periods for cloud-stored messages, including Developer, Standard, Pro, Pro Plus, and Enterprise editions. The getMessageList API fetches message lists by page for specified conversations, suitable for initial loading or pagination. The getMessageListHopping API allows pulling messages by sequence or time range, enabling flexible message retrieval in chat applications. - [Forward Messages](https://pre.trtc.io/document/48874.md): The React Native Chat SDK provides APIs to create, send, download, and forward merged messages in Tencent Cloud Chat. It supports one-to-one and group conversations, allowing users to merge multiple messages into a single message instance with compatibility text for older SDK versions. This guide details the createMergerMessage and downloadMergerMessage APIs, their parameters, and usage examples to help developers implement message merging and forwarding functionality. - [Edit Message](https://pre.trtc.io/document/48875.md): The chat.modifyMessage API in the React Native SDK allows users to modify successfully sent messages within a conversation by updating the cloudCustomData field. It supports text, custom, location, and emoji messages but excludes online and AVChatRoom messages. Upon successful modification, the MESSAGE_MODIFIED event is triggered for all conversation members. This API helps implement features like message replies and references by enabling message content updates with conflict detection and error handling. - [Insert a Message](https://pre.trtc.io/document/48876.md): The React Native SDK provides APIs to insert local messages into one-to-one or group conversations without sending them to the server. These messages are stored locally and useful for displaying tips or notifications like group exit alerts or security reminders. The SDK supports inserting custom messages in Flutter, enabling developers to enrich chat interfaces with local-only content. This guide details the usage of insertC2CMessageToLocalStorage and insertGroupMessageToLocalStorage methods with example code snippets. - [Delete Message](https://pre.trtc.io/document/48878.md): The React Native Messaging SDK provides the deleteMessage API to delete up to 30 messages from the same conversation. This API sets the isDeleted flag to true for each message and prevents deleted messages from being pulled on subsequent logins in one-to-one and group chats. It returns a Promise for asynchronous handling and enforces a one-call-per-second limit. Messages in audio-video groups and group system notifications cannot be deleted using this API. - [Clear History Messages](https://pre.trtc.io/document/48880.md): The clearHistoryMessage API in the React Native chat SDK allows developers to clear all messages in a conversation both locally and from the cloud without deleting the conversation itself. It supports one-to-one and group chats, resets unread counts, and clears the last message content. This API returns a Promise to handle success or failure scenarios, enabling effective message management in chat applications. - [Recall a Message](https://pre.trtc.io/document/48882.md): The React Native Chat SDK supports recalling one-to-one or group messages within a configurable time limit. This guide explains how to use the revokeMessage API to recall messages, handle the MESSAGE_REVOKED event for notifications, and retrieve recalled messages using getMessageList. It is designed for developers integrating message recall functionality into their React Native chat applications. - [Online Message](https://pre.trtc.io/document/48884.md): The React Native Chat SDK provides a messaging feature that ensures messages are only received by online users, preventing offline storage and roaming. It also supports typing indicators in one-to-one chats by sending real-time typing status updates. This guide explains how to use the onlineUserOnly flag in sendMessage, implement UI updates for typing prompts, and leverage Tencent's TUIKit component for seamless integration of typing indicators. - [Read Receipt](https://pre.trtc.io/document/48886.md): The React Native Chat SDK provides a message read receipt feature that enables senders to track who has read their messages. Available to Pro, Pro Plus, and Enterprise edition customers, this guide explains how to enable read receipts, specify messages requiring receipts, send read receipts as a receiver, and listen for receipt notifications. It includes key steps such as setting the needReadReceipt flag, sending read receipts via API, and handling callbacks to manage message read status. - [Query Messages](https://pre.trtc.io/document/48888.md): The Tencent Cloud Chat React Native SDK provides the findMessages API for querying local messages by message ID and the searchCloudMessages API for searching cloud messages with advanced filtering options. These APIs enable developers to retrieve specific chat messages based on keywords, sender IDs, message types, conversation IDs, and time ranges, supporting efficient message management in React Native applications. - [Mentions (@)](https://pre.trtc.io/document/48889.md): The React Native Tencent Cloud Chat SDK guide explains how to implement group @mention messaging. It shows how to detect '@' input in the chat UI, launch group member selection, create @mention messages with createTextAtMessage API, and send them using sendMessage. This quickstart helps developers build interactive group chat features on React Native. - [Targeted Message](https://pre.trtc.io/document/48890.md): The React Native targeted group messaging SDK enables sending messages to specified members within a group, excluding others. Designed for developers using the Pro, Pro Plus, or Enterprise editions, it provides APIs to create and send targeted messages and handles message reception while excluding these messages from unread counts. This guide walks through key steps including message creation, specifying recipients, and sending targeted group messages. - [Do Not Disturb](https://pre.trtc.io/document/48892.md): Tencent Cloud Chat SDK for React Native enables developers to configure message receiving options for one-to-one and group chats, including notification muting and message rejection. This guide provides step-by-step instructions to set conversation message notification types using the chat.setMessageRemindType API, supporting group and topic message notifications and synchronization across devices. - [Message Extension](https://pre.trtc.io/document/52490.md): React Native Chat SDK provides message extension APIs to configure key-value pairs for messages, enabling features like polling, group notices, and surveys. The setMessageExtensions API allows setting or updating extensions on messages, while the getMessageExtensions API retrieves existing extensions. These APIs require messages to support extensions and be successfully sent. This functionality is available to Advanced Edition customers with the feature enabled in the Chat Console. - [Reactions](https://pre.trtc.io/document/57960.md): The Message Response feature in Tencent Cloud Chat SDK for React Native enables adding, deleting, and retrieving emoji reactions on messages. It supports pagination to fetch user profiles for each emoji reaction and provides event listeners to track updates. This API reference details key interfaces such as addMessageReaction, removeMessageReaction, and getMessageReactions, designed for developers implementing interactive message reactions in chat applications. - [Message Translation](https://pre.trtc.io/document/66153.md): The React Native Text Message Translation SDK enables developers to translate text messages within chat applications using Tencent RTC. This feature supports manual API calls to translate text messages between multiple languages including English, Chinese, Japanese, and more. It is available for Pro, Pro Plus, and Enterprise customers who have enabled Text Message Translation in the Chat Console. The quickstart guide covers key steps to integrate and use the chat.translateText API with parameters for source texts, source language detection, and target language selection. - [Voice-to-Text](https://pre.trtc.io/document/66154.md): The React Native Speech-to-Text SDK provides the chat.convertVoiceToText API to convert voice messages into text. It supports multiple audio formats including wav, pcm, ogg-opus, speex, silk, mp3, m4a, aac, and amr. Users can specify the language for recognition, defaulting to Chinese-English-Cantonese, with options for Chinese, English, Cantonese, and Japanese. This API is available from version v3.1.3 and is designed for developers integrating speech recognition into their React Native applications. ### Conversations - [Overview](https://pre.trtc.io/document/48844.md): The Chat SDK React Native provides a Conversation class API to manage different types of conversations including one-to-one, group, and system notification sessions. It enables developers to display and update conversation lists, handle unread message counts, pin conversations, and mute message notifications. The SDK supports pulling recent conversations from the cloud with configurable limits and retains messages for 7 days by default. Key attributes include conversation identifiers, message details, user and group profiles, and notification settings. - [Conversation List](https://pre.trtc.io/document/48841.md): The React Native Chat SDK offers APIs to retrieve and manage conversation lists, enabling users to easily locate target conversations after login. This guide covers how to call the getConversationList API with different filtering options and how to listen for conversation list update events to keep the UI synchronized. - [Get Conversations](https://pre.trtc.io/document/48842.md): The Chat SDK for React Native offers the getConversationList API to retrieve conversation objects for one or multiple specified conversations. This API enables developers to access conversation lists with options to filter by conversation type, mark type, group name, unread counts, and group mention information. It supports pagination and synchronization status to ensure up-to-date conversation data, facilitating efficient chat management in mobile applications. - [Unread Count](https://pre.trtc.io/document/48845.md): The React Native Chat SDK by Tencent Cloud provides developers with tools to manage unread message counts across multiple conversations. It supports retrieving the total unread messages, receiving notifications when unread counts change, and clearing unread counts for individual or all conversations. This SDK is designed for applications that require efficient unread message handling in one-to-one and group chat scenarios, excluding AVChatRoom and system conversations. - [Pin Conversations](https://pre.trtc.io/document/48850.md): The React Native pinConversation API is part of the Tencent RTC chat SDK that allows developers to pin or unpin one-to-one or group conversations at the top of the conversation list. This feature helps users quickly access important chats by fixing them at the top, with the pinned status stored on the server and synchronized across devices. The API accepts conversation ID and pin status parameters, returns a Promise, and triggers an event to update the conversation list accordingly. - [Delete Conversations](https://pre.trtc.io/document/49497.md): The React Native Chat SDK provides the deleteConversation API to delete one-to-one or group chat conversations. It allows users to clear conversation history or retain it based on parameters. The API supports bulk deletion of up to 100 conversations and offers options to enable multi-client synchronization of conversation deletion. This guide details the usage, parameters, and examples of the deleteConversation method for effective conversation management. - [Conversation Draft](https://pre.trtc.io/document/48848.md): The React Native chat SDK provides the setConversationDraft API to save unfinished text messages locally within conversations. This feature enables users to switch chat windows without losing draft content, which is stored only on the local device and not synced across devices. The guide explains how to set, update, and cancel conversation drafts using the API with examples. - [Conversation Mark](https://pre.trtc.io/document/66158.md): The React Native SDK provides APIs for marking conversations with statuses such as favorite, collapsed, hidden, or unread. This API reference details how to set custom data for conversations, mark or unmark conversations, and listen for conversation mark changes. It is designed for developers integrating Tencent RTC chat features into React Native applications, enabling fine-grained control over conversation states and custom metadata management. - [Conversation Group](https://pre.trtc.io/document/66159.md): The React Native Chat SDK provides APIs to manage conversation groups, including creating, deleting, renaming groups, and retrieving group lists. These APIs enable developers to organize conversations into groups such as "Product experience" or "R&D". The SDK supports event notifications for conversation and group list updates. This feature requires the Pro, Pro Plus, or Enterprise edition and enforces a limit of 20 conversation groups per user. ### Search - [Cloud Search Messages](https://pre.trtc.io/document/67678.md): The React Native cloud message search API enables efficient keyword-based retrieval of chat messages across all or specified conversations. Designed for Pro Plus and Enterprise customers, this API supports filtering by sender user IDs and message types, paginated results with cursors, and grouping by conversation ID. It helps developers quickly locate relevant messages, improving information retrieval speed and accuracy in Tencent RTC chat applications. - [Cloud Search Users](https://pre.trtc.io/document/67680.md): The searchCloudUsers API in Tencent Cloud Chat SDK enables keyword-based fuzzy and precise searches of cloud users. It supports filters such as gender and birthday range, returning user profiles with essential fields like avatar, nickname, userID, gender, birthday, and selfSignature. This API facilitates locating known users or discovering new users to expand social connections, with pagination support and defined call frequency limits. - [Cloud Search Channels](https://pre.trtc.io/document/67682.md): Tencent Cloud Chat SDK provides the searchCloudGroups API to enable keyword-based searching of cloud groups. This API allows developers to perform fuzzy matching on group names and exact matching on group IDs, facilitating quick location and discovery of groups. It returns essential group information such as group ID, avatar, name, type, member count, introduction, and owner ID to support rendering search results. The API supports filtering by group types and includes pagination through cursors. Usage limits apply to ensure optimal performance. - [Cloud Search Channel Members](https://pre.trtc.io/document/67684.md): The searchCloudGroupMembers API is part of the Tencent RTC chat SDK that enables keyword fuzzy matching search of cloud group members across groups the user has joined. It supports filtering by keywords, group types, and group IDs, returning partial group and member information to facilitate efficient group member management. This API is available from version 3.5.0 for Pro Plus and Enterprise customers, with usage limits to ensure performance. ### Signaling Management - [Signaling Management](https://pre.trtc.io/document/50076.md) ### Client APIs - [Client APIs](https://pre.trtc.io/document/52488.md): TencentCloudChat JavaScript SDK is a comprehensive chat SDK for React Native that provides APIs for creating SDK instances, managing messages, conversations, user profiles, friends, groups, and signaling. It supports event handling, plugin registration, log level configuration, and SDK lifecycle management. This API reference details the methods and constants available to developers for integrating chat functionalities into React Native applications. ### Changelog - [Changelog](https://pre.trtc.io/document/52398.md)