浏览 SDKs · Flutter
平台
SDKsFlutter

搜索好友

使用 Flutter SDK 搜索当前用户的好友。

复制

根据指定关键字与匹配维度在本地好友列表中执行模糊检索:

参数说明

参数类型是否必填说明
keywordListList<String>是搜索关键字列表。当前建议传入包含单个非空关键字的列表。
isSearchUserIDbool否是否匹配好友的用户 ID。
isSearchNicknamebool否是否匹配好友的昵称。
isSearchRemarkbool否是否匹配为好友设置的备注名。
final results = await OpenIM.iMManager.friendshipManager.searchFriends(
  keywordList: ['alice'],
  isSearchUserID: true,
  isSearchNickname: true,
  isSearchRemark: true,
);

返回结果

Future 成功返回匹配的好友搜索结果列表(List<SearchFriendsInfo>)。

每个 SearchFriendsInfo 包含好友的基本信息及关联匹配字段。搜索结果仅用于驱动当前搜索 UI 呈现,不应直接替换全局联系人列表的持久状态;若需基于搜索结果更新好友关系或发起会话,客户端应以目标好友实体的 userID 作为关联主键。

该查询为本地检索操作,不会触发好友 listener。拉取常规联系人列表请参考分页获取好友列表。