SDKsReact NativeEnterprise

Conversation group overview

Learn about conversation groups in the OpenIM React Native SDK.

Conversation groups classify the current account's conversation list by business scenario, such as work, pending tasks, or custom categories.

Group types

ConversationGroupType contains these values:

Enum value	Numeric value	Description
`ConversationGroupType.ConversationGroupTypeNormal`	`0`	Normal custom group.
`ConversationGroupType.ConversationGroupTypeFilter`	`1`	Group filtered by rules.
`ConversationGroupType.ConversationGroupTypeAll`	`2`	Query all group types.

Group fields

ConversationGroup uses conversationGroupID as its identifier:

Field	Type	Description
`conversationGroupID`	`string`	Conversation-group ID.
`name`	`string`	Group name.
`serial`	`number`	Group sort value.
`version`	`number`	Group data version.
`conversationGroupType`	`ConversationGroupType`	Group type.
`hidden`	`boolean`	Whether the group is hidden.
`unreadCount`	`number`	Total unread count in the group.
`conversationIDs`	`string[]`	Conversation IDs currently in the group.
`ex`	`string` (optional)	Application extension string.

Group operations emit events for added, updated, or deleted groups. Membership events include the group, conversation IDs, and conversation details. Event callbacks receive the entities directly, without a data field. Update groups by conversationGroupID and membership by the event's conversationIDs.

const handleGroupAdded = (groups: ConversationGroup[]) => {
  // ...
};
const handleGroupChanged = (groups: ConversationGroup[]) => {
  // ...
};
const handleGroupDeleted = (groups: ConversationGroup[]) => {
  // ...
};
const handleGroupMemberAdded = (payload: ConversationGroupMemberChangedCallbackData) => {
  // ...
};
const handleGroupMemberDeleted = (payload: ConversationGroupMemberChangedCallbackData) => {
  // ...
};

OpenIMSDK.on(OpenIMEvent.OnConversationGroupAdded, handleGroupAdded);
OpenIMSDK.on(OpenIMEvent.OnConversationGroupChanged, handleGroupChanged);
OpenIMSDK.on(OpenIMEvent.OnConversationGroupDeleted, handleGroupDeleted);
OpenIMSDK.on(OpenIMEvent.OnConversationGroupMemberAdded, handleGroupMemberAdded);
OpenIMSDK.on(OpenIMEvent.OnConversationGroupMemberDeleted, handleGroupMemberDeleted);

OpenIMSDK.off(OpenIMEvent.OnConversationGroupAdded, handleGroupAdded);
OpenIMSDK.off(OpenIMEvent.OnConversationGroupChanged, handleGroupChanged);
OpenIMSDK.off(OpenIMEvent.OnConversationGroupDeleted, handleGroupDeleted);
OpenIMSDK.off(OpenIMEvent.OnConversationGroupMemberAdded, handleGroupMemberAdded);
OpenIMSDK.off(OpenIMEvent.OnConversationGroupMemberDeleted, handleGroupMemberDeleted);

Remove the listeners when the component is destroyed, the user logs out, or the account changes.

Was this page helpful?

Group types

Group fields

Listen for group changes