SDKsuni-app / uni-app x
搜索群成员
按用户 ID 或群内昵称搜索指定群组的成员。
searchGroupMembers() 适合搜索成员或构建群聊 @ 候选人。当前接口只使用 keywordList 中的第一个关键词,UTS 合同不提供分页参数。
参数说明
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
groupID | string | 是 | 目标群组 ID。 |
keywordList | string[] | 是 | 关键词数组;传入一个去除首尾空格的非空关键词。 |
isSearchUserID | boolean | 是 | 是否匹配用户 ID。 |
isSearchMemberNickname | boolean | 是 | 是否匹配群内昵称。 |
import { searchGroupMembers } from '@/uni_modules/unix-openim-sdk'
const result = await searchGroupMembers({
groupID: groupID,
keywordList: [keyword.trim()],
isSearchUserID: true,
isSearchMemberNickname: true,
})
const members = result != null ? result.members : []Promise 成功后返回 OpenIMGroupMemberListResult | null;非空结果的 members 是匹配的 OpenIMGroupMemberItem[]。字段含义见分页查询群成员。
搜索结果是独立结果集,不应替换完整成员列表。关键词或匹配字段变化时,应发起新的搜索并替换当前搜索结果。
这个页面有帮助吗?