浏览 SDKs · uni-app / uni-app x
平台
SDKsuni-app / uni-app x

搜索已加入群组

搜索当前用户已加入并已同步到本地的群组。

复制

在当前用户已加入且已同步到本地数据库的群组中进行搜索,可匹配群名称或群组 ID。当前接口只使用 keywordList 中的第一个关键词,不提供全网公开群探索能力。

参数说明

参数类型是否必填说明
keywordListstring[]是搜索关键词数组;传入一个去除首尾空格的非空关键词。
isSearchGroupIDboolean是是否匹配 groupID。
isSearchGroupNameboolean是是否匹配群名称。
import { searchGroups } from '@/uni_modules/unix-openim-sdk'

const result = await searchGroups({
  keywordList: [keyword.trim()],
  isSearchGroupID: true,
  isSearchGroupName: true,
})
const groups = result != null ? result.groups : []

Promise 成功后返回 OpenIMGroupListResult | null;非空结果的 groups 是匹配的 OpenIMGroupItem[]。客户端应按 groupID 维护搜索结果,并作为独立结果集展示,不要直接覆盖本地完整的已加入群组列表。

公开群目录、分类筛选和复杂权限检索应由业务后端提供。