checkFriend

功能介绍

说明

检验好友关系，如果用户不在自己的好友列表中或者被添加到黑名单中，返回的结果为非好友， 如果仅仅需要检验对方是否在自己的好友列表中，建议调用getSpecifiedFriendsInfo接口。

注意

由于好友关系是双向关系，仅检验对方是否在自己的好友列表中，并不能检验自己是否在对方的好友列表中。

iOS

函数原型

 Future<List<FriendshipInfo>> checkFriend({
    required List<String> userIDList,
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
userIDList	List<String>	是	用户 ID 列表

返回结果

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

FriendshipInfo

字段名称	字段类型	描述
userID	String	用户 UserID
result	int	checkFriend 的时候: result 为 1 表示好友（并且不是黑名单）

代码示例

   final list = await OpenIM.iMManager.friendshipManager.checkFriend(userIDList: ['ID']);

Android

函数原型

- (void)checkFriend:(NSArray <NSString *> *)usersID
          onSuccess:(nullable OIMSimpleResultsCallback)onSuccess
          onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
usersID	NSArray <NSString *>	是	用户 ID 列表

返回结果

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

OIMSimpleResultInfo

字段名称	字段类型	描述
userID	NSString	用户 ID
result	NSInteger	checkFriend 的时候: result 为 1 表示好友（并且不是黑名单）

代码示例

[OIMManager.manager checkFriend:@[]
                              onSuccess:^(NSArray<OIMSimpleResultInfo *> * _Nullable results) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

public void checkFriend(OnBase<List<FriendshipInfo>> callBack, List<String> uidList)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<List<FriendshipInfo>>	是	回调接口
uidList	String	是	用户 ID 集合

FriendInfo

字段名称	字段类型	描述
userID	String	用户 UserID
result	int	1 表示好友（并且不是黑名单）

返回结果

代码示例

OpenIMClient.getInstance().friendshipManager.checkFriend(new OnBase<FriendshipInfo>(){...},uidList)

uni-app

函数原型

type FriendshipInfo = {
    result: number; //  1是好友 0非好友
    userID: string;
};
IMSDK.checkFriend(userIDList: string[], operationID?: string): Promise<WsResponse<FriendshipInfo[]>>

输入参数

参数名称	参数类型	是否必填	描述
userIDList	string[]	是	用户 ID 列表

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<FriendshipInfo[]>>	好友关系结果信息列表
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.checkFriend(userIDList)
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

type FriendshipInfo = {
    result: number; //  1是好友 0非好友
    userID: string;
};
IMSDK.asyncApi('checkFriend', operationID: string, userIDList: string[]): Promise<FriendshipInfo[]>

输入参数

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

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

函数原型

type FriendshipInfo = {
    result: number; //  1是好友 0非好友
    userID: string;
};
OpenIMSDKRN.checkFriend(userIDList: string[], operationID: string): Promise<FriendshipInfo[]>

输入参数

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

返回结果

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

代码示例

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

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

Unity

函数原型

public static void CheckFriend(OnBase<List<UserIDResult>> cb, string[] userIdList)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase<List<UserIDResult>>	是	回调
userIdList	string[]	是	用户 ID 集合

代码示例

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

}, {"userid1","userid2"});