IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
V2TIMConversation

Public 成员函数

String getConversationID ()
 
int getType ()
 
String getUserID ()
 
String getGroupID ()
 
String getShowName ()
 
String getFaceUrl ()
 
int getRecvOpt ()
 
String getGroupType ()
 
int getUnreadCount ()
 
V2TIMMessage getLastMessage ()
 
String getDraftText ()
 
long getDraftTimestamp ()
 
List< V2TIMGroupAtInfogetGroupAtInfoList ()
 
boolean isPinned ()
 
long getOrderKey ()
 
List< Long > getMarkList ()
 
String getCustomData ()
 
List< String > getConversationGroupList ()
 
long getC2CReadTimestamp ()
 
long getGroupReadSequence ()
 

静态 Public 属性

static final int CONVERSATION_TYPE_INVALID = 0
 
static final int V2TIM_C2C = 1
 
static final int V2TIM_GROUP = 2
 
static long V2TIM_CONVERSATION_MARK_TYPE_STAR = 0x1
 
static long V2TIM_CONVERSATION_MARK_TYPE_UNREAD = 0x1 << 1
 
static long V2TIM_CONVERSATION_MARK_TYPE_FOLD = 0x1 << 2
 
static long V2TIM_CONVERSATION_MARK_TYPE_HIDE = 0x1 << 3
 

成员函数说明

◆ getConversationID()

String getConversationID ( )
inline

获取会话 ID

返回
会话ID

◆ getType()

int getType ( )
inline

获取会话类型

返回
会话类型

◆ getUserID()

String getUserID ( )
inline

如果会话类型为 C2C 单聊,userID 会存储对方的用户ID,否则为 null

返回
用户 userID

◆ getGroupID()

String getGroupID ( )
inline

如果会话类型为群聊,groupID 会存储当前群的群 ID,否则为 null

返回
群 ID

◆ getShowName()

String getShowName ( )
inline

获取会话展示名称,其展示优先级如下:

  • 群组:群名称 -> 群 ID
  • C2C:对方好友备注 -> 对方昵称 -> 对方的 userID
返回
展示名称

◆ getFaceUrl()

String getFaceUrl ( )
inline

获取会话展示头像

  • 群组:群头像
  • C2C:对方头像
返回

◆ getRecvOpt()

int getRecvOpt ( )
inline

获取消息接收选项(接收 | 接收但不提醒 | 不接收)

返回

◆ getGroupType()

String getGroupType ( )
inline

获取群类型(群会话有效)

返回

◆ getUnreadCount()

int getUnreadCount ( )
inline

获取未读计数

返回

◆ getLastMessage()

V2TIMMessage getLastMessage ( )
inline

会话最后一条消息

注意
5.5.892 以前版本,请您使用 lastMessage -> timestamp 对会话做排序,timestamp 越大,会话越靠前

◆ getDraftText()

String getDraftText ( )
inline

获取未编辑完的草稿消息(只存本地,程序卸载重装后会丢失)

返回
返回草稿内容, 不存在或者出错时返回 null

◆ getDraftTimestamp()

long getDraftTimestamp ( )
inline

获取上次设置草稿时的 UTC 时间戳

返回
时间,单位:秒

◆ getGroupAtInfoList()

List<V2TIMGroupAtInfo> getGroupAtInfoList ( )
inline

获取群会话 @ 信息列表,用于展示“有人@我”或者“@所有人”等提醒状态。

◆ isPinned()

boolean isPinned ( )
inline

是否置顶

◆ getOrderKey()

long getOrderKey ( )
inline

排序字段(5.5.892 及以后版本支持)

注意
  • 排序字段 orderKey 是按照会话的激活时间线性递增的一个数字(注意:不是时间戳,因为同一时刻可能会有多个会话被同时激活)
  • 5.5.892 及其以后版本,推荐您使用该字段对所有会话进行排序,orderKey 值越大,代表该会话排序越靠前
  • 当您 “清空会话所有消息” 或者 “逐个删除会话的所有消息” 之后,会话的 lastMessage 变为空,但会话的 orderKey 不会改变;如果想保持会话的排序位置不变,可以使用该字段对所有会话进行排序

◆ getMarkList()

List<Long> getMarkList ( )
inline

会话标记列表(从 6.5 版本开始支持)

◆ getCustomData()

String getCustomData ( )
inline

会话自定义数据(从 6.5 版本开始支持)

◆ getConversationGroupList()

List<String> getConversationGroupList ( )
inline

会话所属分组列表

◆ getC2CReadTimestamp()

long getC2CReadTimestamp ( )
inline

最新已读消息的 UTC 时间戳,仅对单聊会话生效(从 7.1 版本开始支持)

◆ getGroupReadSequence()

long getGroupReadSequence ( )
inline

已读消息的 sequence,仅对群聊会话生效(从 7.1 版本开始支持)

结构体成员变量说明

◆ CONVERSATION_TYPE_INVALID

final int CONVERSATION_TYPE_INVALID = 0
static

非法类型

◆ V2TIM_C2C

final int V2TIM_C2C = 1
static

单聊

◆ V2TIM_GROUP

final int V2TIM_GROUP = 2
static

群聊

◆ V2TIM_CONVERSATION_MARK_TYPE_STAR

long V2TIM_CONVERSATION_MARK_TYPE_STAR = 0x1
static

会话标星

◆ V2TIM_CONVERSATION_MARK_TYPE_UNREAD

long V2TIM_CONVERSATION_MARK_TYPE_UNREAD = 0x1 << 1
static

会话标记未读(重要会话)

◆ V2TIM_CONVERSATION_MARK_TYPE_FOLD

long V2TIM_CONVERSATION_MARK_TYPE_FOLD = 0x1 << 2
static

会话折叠

◆ V2TIM_CONVERSATION_MARK_TYPE_HIDE

long V2TIM_CONVERSATION_MARK_TYPE_HIDE = 0x1 << 3
static

会话隐藏