SDKsHarmonyOSEnterprise

Retrieve conversation groups

Query conversation groups for the current account filtered by group category.

Filter conversation groups by custom groups, system filter groups, or all available types:

Code example

import sdk, {
  ConversationGroupQueryType,
  GetConversationGroupsReq,
  GetConversationGroupsResp,
} from '@openimsdk/imsdk';

const request: GetConversationGroupsReq = {
  conversationGroupType: ConversationGroupQueryType.ConversationGroupQueryAll,
};
const response: GetConversationGroupsResp = await sdk.getConversationGroups(request);
const groups = response.conversationGroups;

Parameters

Parameter	Type	Required	Description
`conversationGroupType`	`ConversationGroupQueryType`	Yes	Category filter: `ConversationGroupTypeNormal`, `ConversationGroupTypeFilter`, or `ConversationGroupQueryAll`.

Return value

Returns a Promise that resolves to a GetConversationGroupsResp object:

Property	Type	Description
`conversationGroups`	`IMConversationGroup[]`	Array of conversation group records matching the query criteria.

Resolving the Promise yields the current snapshot of conversation groups without triggering real-time events. Store and render groups keyed by conversationGroupID. For real-time updates across multiple clients, see Conversation groups overview. Re-invoke this method when network connectivity is restored or when state discrepancies occur.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call