SDKsWASM

Get joined groups by page

Page through groups joined by the current user.

Use getJoinedGroupListPage() when the user belongs to many groups.

Parameters

Parameter	Type	Required	Description
`offset`	`number`	Yes	Starting offset. Pass `0` for the first page.
`count`	`number`	Yes	Number of groups to read.

const { data: firstPage } = await openimsdk.getJoinedGroupListPage({
  offset: 0,
  count: 50,
});

After the Promise succeeds, data contains the current page of GroupItem[]. Increase offset by the number of items requested, not by the length of an array that has already incorporated event updates.

Group profile fields

Field	Type	Description
`groupID`	`string`	Stable group ID and merge key for group lists and events.
`groupName`	`string`	Group name.
`faceURL`	`string`	Group avatar URL.
`introduction`	`string`	Group introduction.
`notification`	`string`	Current group announcement.
`notificationUserID`	`string`	User ID that most recently updated the announcement.
`notificationUpdateTime`	`number`	Time when the announcement was last updated.
`ownerUserID`	`string`	Current group owner's user ID.
`creatorUserID`	`string`	User ID that created the group.
`createTime`	`number`	Time when the group was created.
`memberCount`	`number`	Snapshot of the current member count.
`groupType`	`GroupType`	Group type.
`status`	`GroupStatus`	Current group state, such as normal, blocked, dismissed, or group-wide muted.
`needVerification`	`GroupVerificationType`	Policy determining whether joining requires approval.
`applyMemberFriend`	`AllowType`	Whether members may send friend applications to one another.
`lookMemberInfo`	`AllowType`	Whether ordinary members may view other member profiles.
`displayIsRead`	`boolean`	Whether the group displays group-message read state. Browser clients cannot change this field through the group profile API.
`ex`	`string`	Application-defined group extension string.

The group name, avatar, and member count are snapshots at call time. While the list is open, merge group events by groupID. Do not rely only on stale cached data for permission decisions.

If a group-add or group-delete event arrives during pagination, reset pagination and reload from the first page. See Group overview for complete event handling.

Was this page helpful?

Parameters

Return result

Group profile fields