getConversation
功能介绍
获取会话列表
本地存储的会话列表没有数量上限。
云端存储的会话列表最大数量为 100。如果您希望扩展此数量，可以升级旗舰版。旗舰版用户可以在控制台配置最高数量为 500。
长时间没有信息变更，该会话在云端最多保存 7 天。如需放宽限制，请 联系我们。
本地存储的会话和云端存储的会话并不总是一致的，如果用户不主动调用 deleteConversation 接口删除本地的会话，该会话就会一直存在。而云端存储的会话最大只会保存 100 条，且对于长时间没有信息变更的会话，云端最多保存 7 天，所以不同的终端本地显示的会话可能会不一样。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| conversationID | string | 是 | 会话唯一 ID，如果是 C2C 单聊，组成方式为 c2c_userID，如果是群聊，组成方式为 group_groupID |
返回模板
V2TimValueCallback<V2TimConversation>
{
code : number
desc : string
data : {
conversationID : string
type : number
userID : string
groupID : string
showName : string
faceUrl : string
groupType : string
unreadCount : number
lastMessage : V2TimMessage
draftText : string
draftTimestamp : number
isPinned : boolean
recvOpt : number
groupAtInfoList : V2TimGroupAtInfo[]
orderkey : number
}
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | number | 请求结果错误码 |
| desc | string | 请求结果描述符 |
| data | V2TimConversation | 此次拉取到的消息信息 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js'; //添加会话到一个会话分组
//获取指定会话
const getConversationtRes = await TencentImSDKPlugin.v2TIMManager
.getConversationManager()
.getConversation(''); //会话唯一 ID，如果是 C2C 单聊，组成方式为 c2c_userID，如果是群聊，组成方式为 group_groupID
if (getConversationtRes.code === 0) {
//拉取成功
getConversationtRes.data?.conversationID; //会话唯一 ID，如果是单聊，组成方式为 c2c_userID；如果是群聊，组成方式为 group_groupID。
getConversationtRes.data?.draftText; //草稿信息
getConversationtRes.data?.draftTimestamp; //草稿编辑时间，草稿设置的时候自动生成。
getConversationtRes.data?.faceUrl; //会话展示头像，群聊头像：群头像；单聊头像：对方头像。
getConversationtRes.data?.groupAtInfoList; //群会话 @ 信息列表，通常用于展示 “有人@我” 或 “@所有人” 这两种提醒状态。
getConversationtRes.data?.groupID; //当前群聊 ID，如果会话类型为群聊，groupID 会存储当前群的群 ID，否则为 null。
getConversationtRes.data?.groupType; //当前群聊类型，如果会话类型为群聊，groupType 为当前群类型，否则为 null。
getConversationtRes.data?.isPinned; //会话是否置顶
getConversationtRes.data?.lastMessage; //会话最后一条消息
getConversationtRes.data?.orderkey; //会话排序字段
getConversationtRes.data?.recvOpt; //消息接收选项
getConversationtRes.data?.showName; //会话展示名称，群聊会话名称优先级：群名称 > 群 ID；单聊会话名称优先级：对方好友备注 > 对方昵称 > 对方的 userID。
getConversationtRes.data?.type; //会话类型，分为 C2C（单聊）和 Group（群聊）。
getConversationtRes.data?.unreadCount; //会话未读消息数，直播群（AVChatRoom）不支持未读计数，默认为 0。
getConversationtRes.data?.userID; //对方用户 ID，如果会话类型为单聊，userID 会存储对方的用户 ID，否则为 null。
}