getFriendListPage

功能介绍

说明

分页获取指定数量好友的列表。offset为获取时的偏移量, count为获取数量

注意

count数不要过大, 否则请求时长会过长

iOS

函数原型

  Future<List<FriendInfo>> getFriendListPage({String? operationID, bool filterBlack = false, int offset = 0, int count = 40,})

输入参数

参数名称	参数类型	是否必填	描述
filterBlack	bool	否	是否过滤掉黑名单
offset	int	是	分页拉取起始下标
count	int	是	一页拉取的数量

返回结果

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

代码示例

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

Android

函数原型

- (void)getFriendListPageWithFilterBlack:(BOOL)filterBlack 
                          offset:(NSInteger)offset 
                          count:(NSInteger)count
                          onSuccess:(nullable OIMFriendInfoCallback)onSuccess
                         onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
filterBlack	BOOL	否	是否过滤掉黑名单
offset	NSInteger	是	分页拉取起始下标
count	NSInteger	是	一页拉取的数量

返回结果

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

代码示例

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

Flutter

函数原型

public void getFriendListPage(OnBase<List<UserInfo>> base, int offset, int count, Boolean filterBlack)

输入参数

参数名称	参数类型	是否必填	描述
offset	int	是	分页拉取起始下标
count	int	是	一页拉取的数量
filterBlack	Boolean	否	是否过滤掉黑名单

返回结果

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

代码示例

OpenIMClient.getInstance().friendshipManager.getFriendListPage(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.getFriendListPage({
  offset: number;
  count: number;
  filterBlack?: boolean;
}, operationID?: string): Promise<WsResponse<FriendUserItem[]>>

输入参数

参数名称	参数类型	是否必填	描述
offset	number	是	分页拉取起始下标
count	number	是	一页拉取的数量
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 { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();

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

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('getFriendListPage', operationID: string, {
  offset: number;
  count: number;
  filterBlack?: boolean;
}): Promise<FriendUserItem[]>

输入参数

参数名称	参数类型	是否必填	描述
offset	number	是	分页拉取起始下标
count	number	是	一页拉取的数量
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';

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

React-Native

函数原型

OpenIMSDKRN.getFriendListPage({
  offset: number;
  count: number;
  filterBlack?: boolean;
}, operationID: string): Promise<FriendUserItem[]>

输入参数

参数名称	参数类型	是否必填	描述
offset	number	是	分页拉取起始下标
count	number	是	一页拉取的数量
filterBlack	boolean	否	是否过滤掉黑名单
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

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

Unity

函数原型

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

输入参数

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

代码示例

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

},true);