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

创建会话分组

创建会话分组,并可同时加入一个会话。

复制

会话分组属于商业版能力。创建普通分组时需要提供名称、顺序值和分组类型;需要同时加入一个会话时,再传 conversationID。

参数说明

参数类型是否必填说明
namestring是分组名称。
ordernumber是分组顺序值,排序方向由产品统一约定。
conversationGroupTypeOpenIMConversationGroupType是普通分组使用 OpenIMConversationGroupTypeNormal,筛选分组使用 OpenIMConversationGroupTypeFilter。
conversationIDstring 或 null否创建后立即加入分组的会话 ID。
exstring 或 null否应用约定的分组扩展字符串。
import {
  OpenIMConversationGroupTypeNormal,
  createConversationGroup,
} from '@/uni_modules/unix-openim-sdk'

const result = await createConversationGroup({
  name: '工作',
  order: 100,
  conversationGroupType: OpenIMConversationGroupTypeNormal,
  conversationID,
})
const group = result?.conversationGroup

Promise 成功后返回 OpenIMCreateConversationGroupResult | null,新分组位于 conversationGroup。客户端应以 conversationGroupID 为合并标识更新或插入本地分组状态;收到分组变更事件或连接恢复后,可参考会话分组概览重新查询列表校准最新状态。