Browse SDKs · Flutter
Platform
SDKsFlutterEnterprise

Query conversation groups

Query conversation groups for the current user by type using the OpenIM Flutter SDK.

Copy

Retrieve conversation groups belonging to the currently signed-in user filtered by type:

Parameters

ParameterTypeRequiredDescription
conversationGroupTypeConversationGroupType?NoGroup type filter. Defaults to ConversationGroupType.all. Pass ConversationGroupType.custom to query custom user folders only.

Code example

final groups = await OpenIM.iMManager.conversationGroupManager
    .getConversationGroups(
  conversationGroupType: ConversationGroupType.custom,
);

Return value

A successful Future returns a sorted list of ConversationGroupInfo records (List<ConversationGroupInfo>). The client builds or updates the local group snapshot using conversationGroupID as the primary key.

This query returns an immediate data snapshot and does not emit event notifications. For subsequent additions, modifications, and deletions, see Conversation groups overview.