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

查询分组内会话

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

复制

会话分组属于商业版能力。getConversationGroupInfoWithConversations() 同时返回一个分组和当前页会话详情。

参数说明

参数类型是否必填说明
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,
  )
}

返回结果

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

分页结束条件应结合 ConversationTotal 和已经加载的会话数量判断。查询不会触发分组事件;分页期间收到分组变化信号时,应重置分页并重新查询。