Conversation Overview
A conversation is a logical relationship automatically established and maintained by the RC SDK based on information such as the sender, receiver, and conversation type of each message. It is an abstract concept.
Conversation Types
RC supports various conversation types to meet different business scenarios. The client SDK uses the ConversationType enumeration to represent different conversation types. The meanings of each enumeration value are as follows:
| Enumeration Value | Conversation Type |
|---|---|
| ConversationType.PRIVATE | One-to-One Chat |
| ConversationType.GROUP | Group Chat |
| ConversationType.CHATROOM | Chatroom Chat |
| ConversationType.SYSTEM | System Conversation |
The ConversationType enumeration also defines other conversation types, which are now deprecated and no longer maintained.
One-to-One Chat
Refers to a one-on-one chat between two users. The two users can be friends or strangers. RC does not manage user relationships but is responsible for establishing and maintaining the conversation.
Messages in one-to-one conversations are stored in the client's local database.
Group Chat
A group chat involves more than two users. The group member information is provided and maintained by the App, while RC is responsible for delivering messages to all group members. Each group can have up to 3000 members, and there is no limit to the number of groups within an App.
Messages in group conversations are stored in the client's local database.
Chatroom Chat
Chatrooms have no user limit, and massive messages are delivered instantly. Users who leave the chatroom will no longer receive any messages from it, and there is no push notification feature. The conversation relationship is established and maintained by RC. Users can join or leave a chatroom using the SDK's relevant interfaces.
The SDK does not save chatroom messages. All data from the chatroom is cleared when the user exits. For more details, refer to the Chatroom Overview.
System Conversation
A system conversation is established when a system account sends a message to a user. This type of conversation can be established by broadcasting messages or by sending a single notification message, such as a friend request.
Conversation Entity Class
The conversation entity class encapsulated in the client SDK is Conversation. All conversation-related information is retrieved from this entity class.
The following table lists the main properties provided by Conversation:
| Property Name | Type | Description |
|---|---|---|
| targetId | String | The conversation ID (or target ID) used to identify the other party in the conversation.
|
| portraitUrl | String | The URL of the avatar in the conversation. |
| unreadMessageCount | String | The number of unread messages in the conversation. |
| isTop | boolean | Whether the conversation is pinned. |
| conversationTitle | String | The title of the conversation. |
| conversationType | ConversationType | The type of conversation, as described in detail above. |
| latestMessage | MessageContent | The content of the last message stored locally in the client for this conversation. For more details on message storage properties, refer to the Message Introduction section on MessageTag. |
| latestMessageId | int | The ID of the last message stored locally in the client for this conversation. |
| draft | String | The draft information saved in the conversation. For more details, refer to the Draft Detailed Explanation. |
| receivedTime | long | The time when the last message in the conversation was received. 1. The value is a Unix timestamp in milliseconds. 2. The received time is the local time of the client when the message arrives at the receiver. |
| sentTime | long | The time when the last message in the conversation was sent, as a Unix timestamp in milliseconds. 1. When the last message in the conversation is a successfully sent or received message, this returns the time the message arrived at the RC server. 2. When the last message is a failed message, this returns the local sending time of the message. 3. When the conversation has draft information and the draft save time is later than the last message time, this returns the draft save time. |
| receivedStatus | Message.ReceivedStatus | The received status of the last message in the conversation. |
| sentStatus | Message.SentStatus | The sent status of the last message in the conversation. |
| objectName | String | The type name of the last message in the conversation, corresponding to the message content. The predefined message type's objectName can be found in the Message Type Overview. The objectName for custom message types is the value you specify. |
| senderUserId | String | The sender ID of the last message in the conversation. |
| senderUserName | String | The sender's name. This field is for internal SDK use only. |
| notificationStatus | ConversationNotificationStatus | The Do Not Disturb status of the conversation. |
| mentionedCount | int | The number of messages in this conversation where the user has been mentioned. |
| latestMessageDirection | Message.MessageDirection | The direction of the last message in the conversation, either sent or received. |
| latestMessageExtra | String | The additional information of the last message in the conversation. |
| latestMessageUId | String | The unique ID of the last message in the conversation. 1. Only successfully sent messages have a unique ID. 2. The ID is globally unique within the same Appkey. |
| latestMessageReadReceiptInfo | ReadReceiptInfo | The read receipt status of the last message in the conversation, applicable only to group chats. |
| latestMessageConfig | MessageConfig | The configuration information of the last message in the conversation. |
| latestCanIncludeExpansion | boolean | Whether the last message in the conversation allows message expansion. 1. This property is determined when the message is sent and cannot be modified afterward. 2. Expansion information is only supported in one-to-one and group chats; other conversation types cannot set expansion information. |
| latestExpansion | Map<String, String> | The expansion information of the last message in the conversation. For more details, refer to Message Expansion. |
| pushNotificationLevel | int | The Do Not Disturb level of the conversation. For more details, refer to the Do Not Disturb Overview. |