getFriendList

功能介绍

说明

一次性获取自己所有的好友列表。

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
filterBlack	bool	否	是否过滤掉黑名单

返回结果

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

代码示例

    List<FriendInfo> list = await OpenIM.iMManager.friendshipManager.getFriendList();
    // todo

Android

函数原型

- (void)getFriendListWithFilterBlack:(BOOL)filterBlack
                          onSuccess:(nullable OIMFriendInfoCallback)onSuccess
                         onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
filterBlack	BOOL	否	是否过滤掉黑名单

返回结果

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

代码示例

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

Flutter

函数原型

 public void getFriendList(OnBase<List<UserInfo>> base, Boolean filterBlack)

输入参数

参数名称	参数类型	是否必填	描述
filterBlack	Boolean	否	是否过滤掉黑名单

返回结果

参数名称	参数类型	描述
data	List\<UserInfo>	成功返回

代码示例

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

uni-app

函数原型

IMSDK.getFriendList(filterBlack?: boolean, operationID?: string): Promise<WsResponse<FriendUserItem[]>>

输入参数

参数名称	参数类型	是否必填	描述
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();

IMSDK.getFriendList()
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron

函数原型

IMSDK.asyncApi('getFriendList', operationID: string, filterBlack: boolean): Promise<FriendUserItem[]>

输入参数

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

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getFriendList', IMSDK.uuid(), false)
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.getFriendList(filterBlack: boolean, operationID: string): Promise<FriendUserItem[]>

输入参数

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

返回结果

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

代码示例

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

OpenIMSDKRN.getFriendList(false, 'operationID')
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void GetFriendList(OnBase<FriendInfo> cb,bool filterBlack)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase<List<FriendInfo>>	是	回调
filterBlack	bool	是	是否过滤掉黑名单

代码示例

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

},true);