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

查询会话分组列表

按分组类型查询当前用户的会话分组。

复制

会话分组属于商业版能力。按分组类型查询当前账号的会话分组列表。传入 conversationGroupType 参数:使用 OpenIMConversationGroupQueryTypeNormal 查询普通分组,使用 OpenIMConversationGroupQueryTypeFilter 查询筛选分组,使用 OpenIMConversationGroupQueryTypeAll 查询全部类型。

import {
  OpenIMConversationGroupQueryTypeAll,
  getConversationGroups,
} from '@/uni_modules/unix-openim-sdk'

const result = await getConversationGroups({
  conversationGroupType: OpenIMConversationGroupQueryTypeAll,
})
const groups = result?.conversationGroups ?? []

Promise 成功后返回 OpenIMGetConversationGroupsResult | null,分组数组位于 conversationGroups。渲染和缓存时,只处理 conversationGroupID 非空的记录,并以该字段作为稳定标识;完整字段见会话分组概览。

该查询只返回调用时刻的快照数据,不会触发分组事件。收到分组变更事件后,应参考会话分组概览重新获取最新列表,并按 conversationGroupID 合并分组状态。