浏览 SDKs · React Native
SDKsReact Native

搜索好友

OpenIM React Native SDK 搜索好友。

复制

调用 searchFriends() 搜索当前用户的好友。提交搜索前应去除关键词首尾空格;当前请求使用 keywordList 中的第一个非空关键词。

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

参数说明

参数类型是否必填说明
keywordListstring[]搜索关键词数组,当前使用第一个非空关键词。
isSearchUserIDboolean是否匹配用户 ID。
isSearchNicknameboolean是否匹配好友昵称。
isSearchRemarkboolean是否匹配好友备注。

返回 SearchedFriendsInfo[]。每项包含好友信息字段和 relationship0 表示黑名单关系,1 表示好友关系。