Skip to main content

group.members

Generated from spec/protocol.yaml. Do not edit by hand.

Overview

  • ID: 1200
  • Header: GROUP_MEMBERS
  • Direction: Server to Client (s2c)
  • Realm: Groups & Forums
  • Phase: session
  • Since: nitro-1.6.6
  • Summary: Deliver a page of group members

Payload fields

FieldTypeRequiredDescription
groupIdint32requiredGroup identifier.
groupTitlestringrequiredGroup display name.
roomIdint32requiredBase room identifier.
badgestringrequiredBadge code string.
totalMembersCountint32requiredTotal members matching the filter.
memberslist<object>requiredMember entries with rank (int32: 0=owner, 1=admin, 2=member, 3=pending, 4=blocked), id (int32), name (string), figure (string), and joinedAt (string).
isAdminbooleanrequiredWhether the requester is an admin.
pageSizeint32requiredNumber of members per page.
pageIndexint32requiredCurrent page index.
levelint32requiredActive rank filter.
querystringrequiredActive search filter.

Behavior

Sender

Sent in response to a group members request.

Receiver

The client displays the paginated member list with rank indicators.

Notes

  • No additional notes