TIMFriendshipSearchFriends
功能介绍
搜索好友
接口返回本地存储的用户资料，可以根据返回结果中的 relation 来判断是否为好友。
用户搜索只能搜索本地存储过的用户，例如拉取过的好友列表，拉取过的用户资料等。
参数详解
| 参数名称 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| searchFriendsParams | SearchFriendsParams | 是 | 搜索好友的参数 |
返回模板
Promise<commonResult<Array<FriendInfoGetResult>>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<FriendInfoGetResult> | undefined;
json_params?: Array<FriendInfoGetResult> | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
| 名称 | 数值类型 | 描述 |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | 返回状态码 |
| desc | string ｜ undefined | 返回描述 |
| json_param | Array< FriendInfoGetResult > ｜ undefined | 根据具具体接口返回 |
| json_params | Array< FriendInfoGetResult > ｜ undefined | 兼容的字段，某些情况下会返回这个，根据具体接口返回 |
| user_data | string ｜ undefined | ImSDK负责透传的用户自定义数据，未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { SearchFriendsParams } from "im_electron_sdk/dist/interfaces";
let keyword=''
let field = 0
let param:SearchFriendsParams={
params: {
friendship_search_param_keyword_list: [keyword], //选填
friendship_search_param_search_field_list: [field] //选填
},
user_data: "" //选填
}
const {code} = await timRenderInstance.TIMFriendshipSearchFriends(param);
if(code == 0){
// 成功
}