getGroupMemberList

功能介绍

说明

获取指定群的群成员列表。

注意

（1）调用者必须加入此群才可调用；
（2）由于是从 APP 本地获取，一次建议最大10000。

iOS

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群 ID
filter	int	是	过滤成员 0 所有，1 群主 , 2 管理员，3 普通成员，4 管理员+普通成员 5,群主+管理员
offset	int	是	起始偏移
count	int	是	成员个数

返回结果

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

代码示例

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

Android

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群 ID
filter	OIMGroupMemberFilter	是	成员级别
offset	NSInteger	是	起始偏移
count	NSInteger	是	成员个数

返回结果

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

代码示例

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

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

}];

Flutter

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<List<GroupMembersInfo>>	是	回调接口
groupId	String	是	群 ID
filter	int	否	GroupMemberFilter 过滤成员
offset	int	是	偏移量
count	int	是	每页数量

返回结果

代码示例

  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

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群 ID
filter	GroupMemberFilter	是	根据群成员角色过滤
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<GroupMemberItem[]>>	群成员列表
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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.getGroupMemberList({
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群 ID
filter	GroupMemberFilter	是	群成员角色
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<GroupMemberItem[]>	群成员列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getGroupMemberList', IMSDK.uuid(), {
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群 ID
filter	GroupMemberFilter	是	群成员角色
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<GroupMemberItem[]>	群成员列表
Promise.catch()	Promise<OpenIMApiError>	调用失败回调

代码示例

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

OpenIMSDK.getGroupMemberList({
  groupID: '',
  filter: 0,
  offset: 0,
  count: 20,
})
  .then((data) => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

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

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase<List<GroupMembersInfo>>	是	回调接口
groupId	string	是	群 ID
filter	GroupMemberFilter	否	过滤成员
offset	int	是	偏移量
count	int	是	每页数量

返回结果

代码示例

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

}, groupId,  filter,  offset,  count);