SDKsReact NativeEnterprise

Get group message readers

Query members who have or have not read a specific group message by page using the OpenIM React Native SDK.

Query members who have read or not yet read a specific group message with pagination:

Use this method to render the read/unread count badge beside a group message bubble and open the member reader list modal.

const members = await OpenIMSDK.getGroupMessageReaderList({
  conversationID,
  clientMsgID,
  filter: GroupMessageReaderFilter.Read,
  offset: 0,
  count: 50,
});

Parameters

Parameter	Type	Required	Description
`conversationID`	`string`	Yes	Target group conversation ID.
`clientMsgID`	`string`	Yes	Client message ID whose read status is being queried.
`filter`	`GroupMessageReaderFilter`	Yes	Reader filter criteria. Use `Read` for members who have read the message, or `Unread` for members who have not yet read it.
`offset`	`number`	Yes	Pagination offset; pass `0` for the first page.
`count`	`number`	Yes	Maximum number of member records to retrieve.

Return value

A resolved Promise returns GroupMemberItem[] for the current page. Each member is uniquely identified by the composite key groupID:userID. For member attribute definitions, see Group overview. To load subsequent pages, increment offset by the number of members returned from previous pages.

Was this page helpful?