浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x商业版

查询分组内会话

分页查询指定会话分组及其中的会话详情。

复制

会话分组属于商业版能力。按会话分组 ID 分页查询该分组资料及所属会话的详细列表。

参数说明

参数类型是否必填说明
conversationGroupIDstring是要查询的会话分组 ID。
pagination.pageNumbernumber是页码,从 1 开始。
pagination.showNumbernumber是每页读取的会话数量。
import { getConversationGroupInfoWithConversations } from '@/uni_modules/unix-openim-sdk'

const result = await getConversationGroupInfoWithConversations({
  conversationGroupID,
  pagination: {
    pageNumber: 1,
    showNumber: 20,
  },
})

if (result != null) {
  renderConversationGroup(
    result.conversationGroup,
    result.conversations,
    result.ConversationTotal ?? 0,
  )
}

返回结果

字段类型说明
conversationGroupOpenIMConversationGroupItem 或 null当前会话分组资料。
ConversationTotalnumber 或 null分组内会话总数;字段名首字母为大写。
conversationsOpenIMConversationItem[]当前页会话详情。

分页加载完成条件应结合 ConversationTotal 和已加载条目数判断。客户端应以 conversationGroupID 合并分组资料,以 conversationID 合并各会话状态。查询本身不会触发分组事件;收到分组变化事件时,应参考会话分组概览重置分页并重新拉取。