创建群组时的属性配置。

群组配置字段直接平铺在该对象中;未传入时分别使用各字段的默认值。

Constructors

Properties

allowInvites?: boolean

私有群组是否允许普通成员邀请其他用户入群,默认为 false。

avatar?: string

群组的头像,需要传入头像的 URL 地址。

desc?: string

群组描述,不传默认为 ""。

extField?: string

群详情扩展信息,可以采用 json 格式。

groupName?: string

群组名称,不传默认为 ""。

inviteNeedConfirm?: boolean

邀请用户进群是否需要对方同意,默认为 false。

  • false:直接加被邀请人进群。在此情况下,被邀请人设置非自动同意进群不起作用。
  • true:被邀请人设置非自动同意起作用,用户可以选择接受邀请进群,也可选择拒绝邀请。
isPublic?: boolean

群组是否为公开群,默认为 false。

joinApprovalRequired?: boolean

申请加入公开群组是否需要审批,默认为 false。

maxUsers?: number

群最大成员数,默认值 200。

members?: string[]

创建群时的初始群成员数组。群主 ID 非必要。不传则创建的群组初始时除群主外不带其他成员。

reason?: string

邀请群成员加入时的邀请信息,不传默认为 ""。