IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMConversation

Detailed Description

Definition of V2TIMConversation.

Public Member Functions

 V2TIMConversation ()
 
 V2TIMConversation (const V2TIMConversation &conversation)
 
V2TIMConversationoperator= (const V2TIMConversation &conversation)
 
 ~V2TIMConversation ()
 

Data Fields

V2TIMConversationType type
 
V2TIMString conversationID
 
V2TIMString userID
 
V2TIMString groupID
 
V2TIMString groupType
 
V2TIMString showName
 
V2TIMString faceUrl
 
int unreadCount
 
V2TIMReceiveMessageOpt recvOpt
 
V2TIMMessagelastMessage
 
V2TIMGroupAtInfoVector groupAtInfolist
 
V2TIMString draftText
 
uint64_t draftTimestamp
 
bool isPinned
 
uint64_t orderKey
 
V2TIMUInt64Vector markList
 
V2TIMBuffer customData
 
V2TIMStringVector conversationGroupList
 
uint64_t c2cReadTimestamp
 
uint64_t groupReadSequence
 

Constructor & Destructor Documentation

◆ V2TIMConversation() [1/2]

◆ V2TIMConversation() [2/2]

V2TIMConversation ( const V2TIMConversation conversation)

◆ ~V2TIMConversation()

Member Function Documentation

◆ operator=()

V2TIMConversation& operator= ( const V2TIMConversation conversation)

Field Documentation

◆ type

Conversation type.

◆ conversationID

V2TIMString conversationID

Unique ID of a conversation. For one-to-one chats, the value format is String.format("c2c_%s", "userID"). For group chats, the value format is String.format("group_%s", "groupID").

◆ userID

V2TIMString userID

If the conversation type is one-to-one chat, the userID stores the user ID of the peer; otherwise, the userID is nil.

◆ groupID

V2TIMString groupID

If the conversation type is group chat, the groupID stores the current group ID; otherwise, the groupID is nil.

◆ groupType

V2TIMString groupType

Group type of a conversation (valid for group conversations only)

◆ showName

V2TIMString showName

Display name of a conversation. Conversation display name priorities are as follows:

  • Group: group name
  • One-to-one: peer's remarks -> peer's nickname -> peer's userID

◆ faceUrl

V2TIMString faceUrl

Conversation display profile photo.

  • Group: group profile photo
  • One-to-one: peer's profile photo

◆ unreadCount

int unreadCount

Count of unread messages in a conversation.

◆ recvOpt

Message receiving option for a conversation (Receive | Receive but not notify | Not receive)

◆ lastMessage

V2TIMMessage* lastMessage

Last message of a conversation

Attention
For versions earlier than 5.5.892, please use "lastMessage -> timestamp" to sort conversations. The later the timestamp, the higher the order of the conversation.

◆ groupAtInfolist

V2TIMGroupAtInfoVector groupAtInfolist

@ information list in a group conversation, which is used to display "someone@me" or "@All" notifications

◆ draftText

V2TIMString draftText

Draft information, please call SetConversationDraft() API to set draft information.

◆ draftTimestamp

uint64_t draftTimestamp

UTC timestamp when the draft was last set.

◆ isPinned

bool isPinned

Whether to pin on top.

◆ orderKey

uint64_t orderKey

orderKey (supported only in 5.5.892 and later)

Attention
  • The sorting field orderKey is a number that increases linearly according to the conversation activation time (note: this is not a timestamp because multiple conversations may be activated at the same time).
  • For 5.5.892 and later versions, it is recommended that you use this field to sort all conversations. The larger the orderKey value, the higher the order of the conversation.
  • When you clear all messages in a conversation at a time or delete all messages in the conversation one by one, the lastMessage of the conversation becomes empty, but the orderKey of the conversation will not change. In that case, if you want to keep the sorting positions of conversations unchanged, you can use this field to sort all conversations.

◆ markList

Mark list of the conversation(supported only in 6.5 and later versions)

◆ customData

V2TIMBuffer customData

Custom data of the conversation(supported only in 6.5 and later versions)

◆ conversationGroupList

V2TIMStringVector conversationGroupList

Conversation group name list to which the conversation belongs.(supported only in 6.5 and later versions)

◆ c2cReadTimestamp

uint64_t c2cReadTimestamp

UTC timestamp of the latest message which has been read. Valid only for one-to-one chat.(supported only in 7.1 and later versions)

◆ groupReadSequence

uint64_t groupReadSequence

Sequence of the latest message which has been read. Valid only for group chat.(supported only in 7.1 and later versions)