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

创建群组

创建群组并配置初始管理员和普通成员。

复制

createGroup() 接收初始群资料、普通成员列表和可选管理员列表。创建参数不能另行指定群主;创建完成后,应以返回结果中的 ownerUserID 为准。

参数说明

参数类型是否必填说明
groupInfoOpenIMCreateGroupInfo初始群资料。
groupInfo.groupNamestring群名称。
groupInfo.groupTypeOpenIMGroupType创建常规工作群时传 OpenIMGroupTypeWorkingGroup
groupInfo.notificationstring初始群公告。
groupInfo.introductionstring初始群简介。
groupInfo.faceURLstring群头像地址。
groupInfo.exstring群组扩展字符串。
memberUserIDsstring[]初始普通成员用户 ID。
adminUserIDsstring[]初始管理员用户 ID。

普通成员和管理员列表应先去重,并检查两组列表不存在交集。是否允许显式包含当前登录用户以服务端校验结果为准;创建参数不能另行指定群主。

import {
  OpenIMGroupTypeWorkingGroup,
  createGroup,
} from '@/uni_modules/unix-openim-sdk'

const group = await createGroup({
  groupInfo: {
    groupName: '项目讨论组',
    groupType: OpenIMGroupTypeWorkingGroup,
    faceURL: 'https://example.com/group.png',
  },
  memberUserIDs: ['user-003', 'user-004'],
  adminUserIDs: ['user-002'],
})

if (group != null) {
  openGroupPage(group.groupID)
}

Promise 成功后返回 OpenIMGroupItem | null。非空结果可以立即用于群资料页;收到 onJoinedGroupAdded() 后,再按 groupID 合并已加入群组列表。完整监听见群组概览