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

创建会话分组

商业版创建自定义会话分组。

复制

createConversationGroup() 商业版 创建分组,并可把一个会话作为初始成员。

参数说明

参数类型是否必填说明
namestring分组名称。提交前按产品规则校验空值和长度。
ordernumber分组排序值;排序方向应在业务中保持一致。
conversationGroupTypeOpenIMConversationGroupType分组类型,使用插件合同允许的值。
conversationIDstringnull创建时加入分组的初始会话 ID。
exstringnull分组扩展字符串,完整覆盖,不会自动合并 JSON。
import { createConversationGroup } from '@/uni_modules/unix-openim-sdk'

const result = await createConversationGroup({
  name: '重要会话',
  order: 100,
  conversationGroupType: 0,
  conversationID: conversationID,
  ex: '',
})

const group = result?.conversationGroup

返回结果

Promise 成功直接返回 OpenIMCreateConversationGroupResult | null。非空结果的 conversationGroup 是新分组快照,也可能为 null;先校验非空 conversationGroupID 再加入本地索引。

Promise 成功和 onConversationGroupAdded 到达是两个阶段。最终列表以 raw 事件触发后的重新查询为准;若指定了初始 conversationID,成员关系也应以查询结果校准。