getGroupMemberList

Description

info

Get the list of group members in a specified group.

Note

(1) The caller must join this group before calling;
(2) Since it is retrieved locally from the APP, the recommended maximum is 10,000 at a time.

iOS

Function Prototype

 Future<List<GroupMembersInfo>> getGroupMemberList({
    required String groupID,
    int filter = 0,
    int offset = 0,
    int count = 0,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	String	Yes	Group ID
filter	int	Yes	Filter members: 0 all, 1 group owner, 2 administrator, 3 ordinary member, 4 administrator + ordinary member, 5 group owner + administrator
offset	int	Yes	Start offset
count	int	Yes	Number of members

Return Result

Parameter Name	Parameter Type	Description
~	List<GroupMemberInfo>	Success

Code Example

   List<GroupMembersInfo> list = await OpenIM.iMManager.groupManager.getGroupMemberList(
      groupID: 'groupID',
    );
    // todo

Android

Function Prototype

- (void)getGroupMemberList:(NSString *)groupID
                    filter:(OIMGroupMemberFilter)filter
                    offset:(NSInteger)offset
                     count:(NSInteger)count
                 onSuccess:(nullable OIMGroupMembersInfoCallback)onSuccess
                 onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	NSString	Yes	Group ID
filter	OIMGroupMemberFilter	Yes	Member level
offset	NSInteger	Yes	Start offset
count	NSInteger	Yes	Number of members

Return Result

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

Code Example

[OIMManager.manager getGroupMemberList:@""
                                filter:0
                                offset:0
                                 count:20
                             onSuccess:^(NSArray<OIMGroupMemberInfo *> * _Nullable groupMembersInfo) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

Function Prototype

public void getGroupMemberList(OnBase<List<GroupMembersInfo>> callBack, String groupId, int filter, int offset, int count)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase<List<GroupMembersInfo>>	Yes	Callback interface
groupId	String	Yes	Group ID
filter	int	No	GroupMemberFilter filter members
offset	int	Yes	Offset
count	int	Yes	Number per page

Return Result

Code Example

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

            }

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

            }
        }, groupId,  filter,  offset,  count);

uni-app

Function Prototype

IMSDK.getGroupMemberList({
    groupID: string;
    filter: GroupMemberFilter;
    offset: number;
    count: number;
}, operationID?: string): Promise<WsResponse<GroupMemberItem[]>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
filter	GroupMemberFilter	Yes	Filter by group member role
offset	number	Yes	Start offset, used for paginated pull
count	number	Yes	Number of members fetched per page

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<GroupMemberItem[]>>	Group member 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();

// use in mini program
// import { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.getGroupMemberList({
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then(({ data }) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi("getGroupMemberList",operationID: string,
  {
    groupID: string;
    filter: GroupMemberFilter;
    offset: number;
    count: number;
  }
): Promise<GroupMemberItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
groupID	string	Yes	Group ID
filter	GroupMemberFilter	Yes	Group member role
offset	number	Yes	Start offset, used for paginated pull
count	number	Yes	Number of members fetched per page

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<GroupMemberItem[]>	Group member list
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getGroupMemberList', IMSDK.uuid(), {
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then((data) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.getGroupMemberList({
  groupID: string,
  filter: GroupMemberFilter,
  offset: number,
  count: number,
}, operationID?: string): Promise<GroupMemberItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
filter	GroupMemberFilter	Yes	Group member role
offset	number	Yes	Start offset, used for paginated pull
count	number	Yes	Number of members fetched per page
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<GroupMemberItem[]>	Group member list
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

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

OpenIMSDK.getGroupMemberList({
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then((data) => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void GetGroupMemberList(OnBase<List<GroupMember>> cb, string groupId, GroupMemberFilter filter, int offset, int count)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase<List<GroupMembersInfo>>	Yes	Callback interface
groupId	string	Yes	Group ID
filter	GroupMemberFilter	No	Filter members
offset	int	Yes	Offset
count	int	Yes	Number per page

Return Result

Code Example

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

}, groupId,  filter,  offset,  count);