Get conversation groups
Query the authenticated user’s conversation groups filtered by group type.
Querying conversation groups is a Commercial Edition capability. Filter conversation groups by passing conversationGroupType: use OpenIMConversationGroupQueryTypeNormal for custom user groups, OpenIMConversationGroupQueryTypeFilter for rule-filtered groups, or OpenIMConversationGroupQueryTypeAll to retrieve all groups.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
conversationGroupType | OpenIMConversationGroupQueryType | Yes | Query filter: OpenIMConversationGroupQueryTypeNormal (0), OpenIMConversationGroupQueryTypeFilter (1), or OpenIMConversationGroupQueryTypeAll (2). |
Code example
import {
OpenIMConversationGroupQueryTypeAll,
getConversationGroups,
} from '@/uni_modules/unix-openim-sdk'
const result = await getConversationGroups({
conversationGroupType: OpenIMConversationGroupQueryTypeAll,
})
const groups = result?.conversationGroups ?? []Return value
The Promise resolves with an OpenIMGetConversationGroupsResult | null object. The returned categories are stored in conversationGroups (OpenIMConversationGroupItem[]). Process only items with a non-null conversationGroupID, using it as the stable merge key. For property definitions, see Conversation group overview.
State changes after the call
This call returns a point-in-time snapshot of locally synchronized groups and does not trigger events. When conversation group update events arrive, re-query the list and merge group state by conversationGroupID as documented in Conversation group overview.
Was this page helpful?