getSpecifiedFriendsInfo

功能介绍

说明

获取指定好友的昵称、头像、备注，此函数从 APP 本地获取，建议一次最大10000个。

iOS

函数原型

    Future<List<FriendInfo>> getFriendsInfo({
        required List<String> userIDList,
        bool filterBlack = false,
        String? operationID,
    })

输入参数

参数名称	参数类型	是否必填	描述
userIDList	List< String>	是	用户 ID 列表
filterBlack	bool	否	是否过滤掉黑名单

返回结果

参数名称	参数类型	描述
~	List< FriendInfo >	成功返回

代码示例

     List<FriendInfo> list = await OpenIM.iMManager.friendshipManager.getFriendsInfo(userIDList: []);
     // todo

Android

函数原型

- (void)getSpecifiedFriendsInfo:(NSArray <NSString *> *)usersID 
                    filterBlack:(BOOL)filterBlack 
                       onSuccess:(nullable OIMFriendInfoCallback)onSuccess
                       onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
usersID	NSArray \<NSString *>	是	用户 ID 列表
filterBlack	BOOL	是	是否过滤掉黑名单

返回结果

参数名称	参数类型	描述
onSuccess	NSArray\<List< OIMFriendInfo * >	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager getSpecifiedFriendsInfo:@[] 
                                filterBlack: NO
                                  onSuccess:^(NSArray<OIMFriendInfo *> * _Nullable userInfos) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

public void getFriendsInfo(OnBase<List<UserInfo>> base, List<String> uidList, Boolean filterBlack)

输入参数

参数名称	参数类型	是否必填	描述
userIDList	List\<String>	是	用户 ID 列表
filterBlack	Boolean	否	是否过滤掉黑名单

代码示例

OpenIMClient.getInstance().friendshipManager.getFriendsInfo(new OnBase<List<UserInfo>>() {
    @Override
    public void onError(int code, String error) {
        // todo: 处理错误信息
    }
    @Override
    public void onSuccess(List<UserInfo> data) {
        // todo: 请求成功，返回List<UserInfo>
    }
}, uidList, filterBlack);

uni-app

函数原型

IMSDK.getSpecifiedFriendsInfo({
  friendUserIDList: string[];
  filterBlack?: boolean;
}, operationID?: string): Promise<WsResponse<FriendUserItem[]>>

输入参数

参数名称	参数类型	是否必填	描述
friendUserIDList	string[]	是	用户 ID 列表
filterBlack	boolean	否	是否过滤掉黑名单
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<FriendUserItem[]>>	好友信息列表
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();

// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();

// use in mini program
// import { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

const userIDList = ['userID1', 'userID2'];
IMSDK.getSpecifiedFriendsInfo({ 
  friendUserIDList: userIDList 
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('getSpecifiedFriendsInfo', operationID: string, {
  friendUserIDList: string[];
  filterBlack?: boolean;
}): Promise<FriendUserItem[]>

输入参数

参数名称	参数类型	是否必填	描述
friendUserIDList	string[]	是	用户 ID 列表
filterBlack	boolean	否	是否过滤掉黑名单
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<FriendUserItem[]>>	好友信息列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

const userIDList = ['userID1', 'userID2'];
IMSDK.asyncApi('getSpecifiedFriendsInfo', IMSDK.uuid(), {
  friendUserIDList: userIDList
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.getSpecifiedFriendsInfo({
  friendUserIDList: string[];
  filterBlack?: boolean;
}, operationID: string): Promise<FriendUserItem[]>

输入参数

参数名称	参数类型	是否必填	描述
friendUserIDList	string[]	是	用户 ID 列表
filterBlack	boolean	否	是否过滤掉黑名单
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<FriendUserItem[]>>	好友信息列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from "open-im-sdk-rn";

const userIDList = ['userID1', 'userID2'];
OpenIMSDKRN.getSpecifiedFriendsInfo({
  friendUserIDList: userIDList
}, 'operationID')
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void GetSpecifiedFriendsInfo(OnBase<List<FriendInfo>> cb, string[] userIdList,bool filterBlack)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase<List<FriendInfo>>	是	回调
userIdList	string[]	是	用户 ID 集合
filterBlack	bool	是	是否过滤掉黑名单

代码示例

IMSDK.GetSpecifiedFriendsInfo((list,errCode,errMsg)=>{

},{"userid"},true);