getJoinedGroupList

Description

info

Get the list of joined groups.

Note

If the joined group has been dismissed, it will not be returned.

iOS

Function Prototype

  Future<List<GroupInfo>> getJoinedGroupList({String? operationID})

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
~	List<GroupInfo>	Success

Code Example

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

Android

Function Prototype

- (void)getJoinedGroupListWithOnSuccess:(nullable OIMGroupsInfoCallback)onSuccess
                                onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

None

Return Result

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

Code Example

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

Flutter

Function Prototype

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

Input Parameters

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

Return Result

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 Prototype

IMSDK.getJoinedGroupList(operationID?: string): Promise<WsResponse<GroupItem[]>>

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<GroupItem[]>>	Joined group list
Promise.catch()	Promise<WsResponse>	Failure 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();

IMSDK.getJoinedGroupList()
  .then(({ data }) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron

Function Prototype

IMSDK.asyncApi('getJoinedGroupList', operationID: string): Promise<GroupItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

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

Code Example

import IMSDK from 'openim-uniapp-polyfill';

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

React-Native

Function Prototype

OpenIMSDK.getJoinedGroupList(operationID?: string): Promise<GroupItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<GroupItem[]>	Joined group list
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

 OpenIMSDK.getJoinedGroupList()
  .then((data) => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void GetJoinedGroupList(OnBase<List<GroupInfo>> cb)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase<List<GroupInfo>>	Yes	Callback

Return Result

Code Example

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

});