OpenIMDocs

Type at least two characters to search titles and routes.

EN

Language

ENEnglishEnglish docs简中简体中文中文文档
Browse SDKs · WASM
SDKsWASM

Search groups

Search groups joined by the current user and synchronized locally.

Copy

searchGroups() searches only groups that the current user has joined and that have synchronized locally. The current API uses only the first item in keywordList.

Parameters

ParameterTypeRequiredDescription
keywordListstring[]YesSearch keywords. Pass one non-empty, trimmed keyword.
isSearchGroupIDbooleanYesWhether to match groupID.
isSearchGroupNamebooleanYesWhether to match group names.
const { data: groups } = await openimsdk.searchGroups({
  keywordList: [keyword.trim()],
  isSearchGroupID: true,
  isSearchGroupName: true,
});

Return result

After the Promise succeeds, data contains the matched GroupItem[]. See Get joined groups by page for field descriptions. Search results are a snapshot for the current keyword and must not replace the complete joined-group list.

Public group discovery, complex categories, and permission filtering do not belong to this method and should be implemented by the application backend.