getFriendList

Feature Introduction

Description

Retrieve all of one's friends in a single call.

iOS

Function Prototype

  Future<List<FriendInfo>> getFriendList({String? operationID})

Input Parameters

None

Return Values

Parameter Name	Parameter Type	Description
~	List< FriendInfo * >	Success

Code Example

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

Android

Function Prototype

- (void)getFriendListWithOnSuccess:(nullable OIMFriendsInfoCallback)onSuccess
                         onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

None

Return Values

Parameter Name	Parameter Type	Description
onSuccess	NSArray< OIMFriendInfo * >	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

 public void getFriendList(OnBase<List<UserInfo>> callBack)

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
callBack	OnBase<List<UserInfo>>	Yes	Callback

Return Values

Parameter Name	Parameter Type	Description
data	List<UserInfo>	Success

Code Example

OpenIMClient.getInstance().friendshipManager.getFriendList(new OnBase<List<UserInfo>>(){
    @Override
    public void onError(int code, String error) {

    }

    @Override
    public void onSuccess(List<UserInfo> data) {

    }
})

uni-app

Function Prototype

IMSDK.getFriendList(operationID?: string): Promise<WsResponse<FullUserItem[]>>

Input Parameters

None

Return Values

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<FullUserItem[]>>	List of friend info
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

import { getSDK } from 'open-im-sdk-wasm';
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.getFriendList()
  .then(({ data }) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID for troubleshooting, recommended unique timestamp

Return Values

Utilizing the openim-uniapp-polyfill package to make the function Promise-based. Use then and catch to handle successful and failed callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<FullUserItem[]>	List of friend info
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getFriendList', IMSDK.uuid())
  .then((data) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDKRN.getFriendList(operationID: string): Promise<FullUserItem[]>

Input Parameters

Parameter Name	Parameter Type	Mandatory	Description
operationID	string	Yes	Operation ID, used for problem location, keep unique, suggest using current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<FriendUserItem[]>	List of friend info
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

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

OpenIMSDKRN.getFriendList('operationID')
  .then((data) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Unity

Function Prototype

public static void GetFriendList(OnFullUserInfoList cb)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnFullUserInfoList	Yes	Callback

Code Example

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

});