Interface CreateGroupParams

创建群组时的参数。

interface CreateGroupParams {
    name: string;
    description: string;
    memberIds?: readonly string[];
    public: boolean;
    joinApprovalRequired: boolean;
    allowInvites: boolean;
    inviteNeedConfirm: boolean;
    maxMembers?: number;
    ext?: string;
    avatar?: string;
}

Properties

name description memberIds? public joinApprovalRequired allowInvites inviteNeedConfirm maxMembers? ext? avatar?

Properties

Readonlyname

name: string

群组名称。

Readonlydescription

description: string

群组描述。

Optional ReadonlymemberIds

memberIds?: readonly string[]

初始成员用户 ID 列表。

Readonlypublic

public: boolean

群组是否为公开群。

ReadonlyjoinApprovalRequired

joinApprovalRequired: boolean

用户加入群组时是否需要管理员审批。

ReadonlyallowInvites

allowInvites: boolean

是否允许普通成员邀请其他用户加入群组。

ReadonlyinviteNeedConfirm

inviteNeedConfirm: boolean

受邀用户加入群组前是否需要确认邀请。

Optional ReadonlymaxMembers

maxMembers?: number

群组最大成员数。

Optional Readonlyext

ext?: string

群组扩展信息。

Optional Readonlyavatar

avatar?: string

群头像地址或标识。

Settings

Member Visibility

On This Page

Properties