The group information class, which contains the information of the chat group.

You can call the ChatGroupManager.fetchGroupInfoFromServer method to obtain group information.

Constructors

  • Parameters

    • params: {
          adminList?: string[];
          announcement?: string;
          blockList?: string[];
          description?: string;
          groupId: string;
          groupName?: string;
          isAllMemberMuted?: boolean;
          memberCount?: number;
          memberList?: string[];
          messageBlocked?: boolean;
          muteList?: string[];
          options?: any;
          owner: string;
          permissionType: number;
      }
      • OptionaladminList?: string[]
      • Optionalannouncement?: string
      • OptionalblockList?: string[]
      • Optionaldescription?: string
      • groupId: string
      • OptionalgroupName?: string
      • OptionalisAllMemberMuted?: boolean
      • OptionalmemberCount?: number
      • OptionalmemberList?: string[]
      • OptionalmessageBlocked?: boolean
      • OptionalmuteList?: string[]
      • Optionaloptions?: any
      • owner: string
      • permissionType: number

    Returns ChatGroup

Properties

adminList: string[]

The admin list of the group.

announcement: string

The content of the group announcement.

blockList: string[]

The block list of the group.

description: string

The group description.

groupId: string

The group ID.

groupName: string

The group name.

isAllMemberMuted: boolean

Whether all group members are muted.

  • true: Yes.
  • false: No.
memberCount: number

The member count of the group.

memberList: string[]

The member list of the group.

messageBlocked: boolean

Whether group messages are blocked.

  • true: Yes.
  • false: No.
muteList: string[]

The mute list of the group.

The group options.

owner: string

The user ID of the group owner.

permissionType: ChatGroupPermissionType

The role of the current user in the group.

Accessors

  • get maxCount(): number
  • Gets the maximum number of members allowed in a group. The parameter is set when the group is created.

    Returns number