getJoinedGroupListPage

Feature Introduction

Note

Split fetch the list of groups you've joined.

Warning

If a joined group has been disbanded, it won't appear in the returned list.

iOS

Function Signature

    Future<List<GroupInfo>> getJoinedGroupListPage({String? operationID, int offset = 0, int count = 40});

Input Parameters

参数名称	参数类型	是否必填	描述
offset	int	是	分页拉取起始下标
count	int	是	一页拉取的数量

Return Results

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

Code Example

    List<GroupInfo> list = await OpenIM.iMManager.groupManager.getJoinedGroupListPage();
    // todo

Android

Function Signature

- (void)getJoinedGroupListPageWithOffset:(NSInteger)offset
                                   count:(NSInteger)count
                               onSuccess:(nullable OIMGroupsInfoCallback)onSuccess
                                onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

参数名称	参数类型	是否必填	描述
offset	int	是	分页拉取起始下标
count	int	是	一页拉取的数量

Return Results

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

Code Example

[OIMManager.manager getJoinedGroupListWithOffset:
                                   count:
                                   onSuccess:^(NSArray<OIMGroupInfo *> * _Nullable groupsInfo) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

Function Signature

    public void getJoinedGroupList(OnBase<List<GroupInfo>> callBack)

Input Parameters

Parameter Name	Data Type	Required	Description
callBack	OnBase< List< GroupInfo>>	Yes	Callback Interface

Return Results

Code Example

OpenIMClient.getInstance().groupManager.getJoinedGroupList(new OnBase<List<GroupInfo>>() {
            @Override
            public void onError(int code, String error) {

            }

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

            }
        });

uni-app

Function Signature

IMSDK.getJoinedGroupList({
  offset: number;
  count: number;
}, operationID?: string): Promise<WsResponse<GroupItem[]>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
offset	number	Yes	Page pulls the start subscript
count	number	Yes	The number of pulls per page
operationID	string	No	Operation ID, which is used to locate the problem. Keep it unique. You are advised to use the current time and random number

Return Results

Parameter Name	Data Type	Description
Promise.then()	Promise< WsResponse< GroupItem[]>>	Joined group list
Promise.catch()	Promise< WsResponse>	Failed call callback

Code Example

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.getJoinedGroupList({ offset: 0, count: 1000 })
  .then(({ data }) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Browser/Electron/MiniProgram

Function Signature

IMSDK.asyncApi('getJoinedGroupList', operationID: string, {
  offset: number;
  count: number;
}): Promise<GroupItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
offset	number	Yes	Page pulls the start subscript
count	number	Yes	The number of pulls per page
operationID	string	Yes	Operation ID, which is used to locate the problem. Keep it unique. You are advised to use the current time and random number

Return Results

Using the openim-uniapp-polyfill package makes the function Promise-based. When calling, use then and catch to determine and handle successful and failed callbacks.

Parameter Name	Data Type	Description
Promise.then()	Promise<GroupItem[]>	Joined group list
Promise.catch()	Promise<CatchResponse>	Failed call callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getJoinedGroupList', IMSDK.uuid(), { offset: 0, count: 1000 })
  .then((data) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

React-Native

Function Prototype

OpenIMSDKRN.getJoinedGroupList({
  offset: number;
  count: number;
}, operationID: string): Promise<GroupItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
offset	number	Yes	Page pulls the start subscript
count	number	Yes	The number of pulls per page
operationID	string	Yes	Operation ID, which is used to locate the problem. Keep it unique. You are advised to use the current time and random number

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<GroupItem[]>	Joined group list
Promise.catch()	Promise<CatchResponse>	Callback on failed call

Code Example

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

 OpenIMSDKRN.getJoinedGroupList({
  offset: 0;
  count: 1000;
}, 'operationID')
  .then((data) => {
    // Successful call
  })
  .catch(({ errCode, errMsg }) => {
    // Failed call
  });

Unity

Function Prototype

public static void GetJoinedGroupListPage(OnBase<List<GroupInfo>> cb, int offset, int count)

Input Parameter

Parameter Name	Parameter Type	Mandatory	Description
cb	OnBase<List<GroupInfo>>	Yes	Callback
offset	int	Yes	Page pulls the start subscript
count	int	Yes	The number of pulls per page

Return Result

Code Example

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

});