Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateGroupParams

Parameters for creating a new group.

Hierarchy

  • Omit<IGroupInfoOption, "portraitUri" | "joinPermission" | "memberInfoEditPermission" | "removeMemberPermission" | "invitePermission" | "groupInfoEditPermission">
    • CreateGroupParams

Index

Properties

Properties

Optional introduction

introduction?: string

Group introduction

Optional notice

notice?: string

Group announcement

Optional extProfile

extProfile?: Record<string, string>

Extended profile

Optional inviteHandlePermission

inviteHandlePermission?: GroupInviteHandlePermission

Invitation-only group mode

groupId

groupId: string

Group ID

description

1 to 64 characters, supports only letters, numbers, and -_+=|: characters.

Optional groupName

groupName?: string

Group name

description

1 to 64 characters, cannot be pure spaces

Optional avatarUrl

avatarUrl?: string

The avatar URL of the group

Optional inviteeUserIds

inviteeUserIds?: string[]

User IDs to invite into the group upon creation

Optional joinPermission

joinPermission?: GroupJoinPermission

Active join group permission verification method

Optional memberInfoEditPermission

memberInfoEditPermission?: GroupMemberInfoEditPermission

Group member information editing permissions

Optional removeMemberPermission

removeMemberPermission?: GroupOperationPermission

Set the mode for removing group members from a group

Optional invitePermission

invitePermission?: GroupOperationPermission

Group invitation mode

Optional groupInfoEditPermission

groupInfoEditPermission?: GroupOperationPermission

Group information update mode