浏览 SDKs · WASM
SDKsWASM

搜索好友

搜索当前用户的好友。

复制

当前只使用一个非空关键词;提交搜索前应去除首尾空格。

参数说明

参数类型是否必填说明
keywordListstring[]搜索关键词数组;当前只使用第一个非空关键词。
isSearchUserIDboolean是否匹配用户 ID。
isSearchNicknameboolean是否匹配好友昵称。
isSearchRemarkboolean是否匹配好友备注。
const { data: friends } = await openimsdk.searchFriends({
  keywordList: [keyword.trim()],
  isSearchUserID: true,
  isSearchNickname: true,
  isSearchRemark: true,
});

Promise 成功后的结果是 SearchedFriendsInfo[],可从 data 读取。每一项包含 FriendUserItem 的全部字段,并额外提供 relationship 关系值。好友资料字段见分页获取好友列表

搜索结果只用于建立当前条件下的展示快照;应以 userID 关联现有好友状态,不要覆盖完整好友列表。