SDKsuni-app / uni-app x

搜索好友

按用户 ID、昵称或好友备注搜索当前用户的好友。

当前只使用一个非空关键词；提交搜索前应去除首尾空格，并至少启用一种匹配方式。

参数说明

参数	类型	是否必填	说明
`keywordList`	`string[]`	是	搜索关键词数组，当前只使用第一个非空关键词。
`isSearchUserID`	`boolean`	是	是否匹配用户 ID。
`isSearchNickname`	`boolean`	是	是否匹配好友昵称。
`isSearchRemark`	`boolean`	是	是否匹配好友备注。

import { searchFriends } from '@/uni_modules/unix-openim-sdk'

const result = await searchFriends({
  keywordList: [keyword.trim()],
  isSearchUserID: true,
  isSearchNickname: true,
  isSearchRemark: true,
})
const matchedFriends = result?.friends ?? []

Promise 成功后返回 OpenIMFriendListResult | null，匹配的好友位于 friends。每一项都是 OpenIMFriendUserItem，完整字段见分页获取好友列表。

搜索结果只代表本次查询命中的好友。应使用 userID 与现有好友资料对应，不要用搜索结果覆盖完整好友列表。该查询不会触发好友事件。

这个页面有帮助吗？