getGroupMemberListByJoinTimeFilter

功能介绍

说明

获取某个群的群成员信息，支持按照入群时间过滤。

注意

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

iOS

函数原型

 Future<List<GroupMembersInfo>> getGroupMemberListByJoinTime({
    required String groupID,
    int offset = 0,
    int count = 0,
    int joinTimeBegin = 0,
    int joinTimeEnd = 0,
    List<String> filterUserIDList = const [],
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
groupID	String	是	群ID
offset	int	是	起始偏移，分页拉取使用
count	int	是	分页拉取，一页拉取的成员个数
joinTimeBegin	int	是	最早加入时间，为 0 时不限制
joinTimeEnd	int	是	最晚加入时间，为 0 时不限制
filterUserIDList	List<String>	否	需要排除的群成员 userID 列表

返回结果

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

代码示例

    List<GroupMembersInfo> list = await OpenIM.iMManager.groupManager.getGroupMemberListByJoinTime(
          groupID: 'groupId',

    );
    // todo

Android

函数原型

- (void)getGroupMemberListByJoinTimeFilter:(NSString *)groupID
                                    offset:(NSInteger)offset
                                     count:(NSInteger)count
                             joinTimeBegin:(NSInteger)joinTimeBegin
                               joinTimeEnd:(NSInteger)joinTimeEnd
                          filterUserIDList:(NSArray <NSString *> *)filterUserIDList
                                 onSuccess:(nullable OIMGroupMembersInfoCallback)onSuccess
                                 onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群ID
offset	NSInteger	是	起始偏移，分页拉取使用
count	NSInteger	是	分页拉取，一页拉取的成员个数
joinTimeBegin	NSInteger	是	最早加入时间，为 0 时不限制
joinTimeEnd	NSInteger	是	最晚加入时间，为 0 时不限制
filterUserIDList	NSArray <NSString *>	是	需要排除的群成员 userID 列表

返回结果

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

代码示例

[OIMManager.manager getGroupMemberListByJoinTimeFilter:@""
                                                        offset:0
                                                         count:100
                                                 joinTimeBegin:[NSDate new].timeIntervalSince1970
                                                   joinTimeEnd:[NSDate new].timeIntervalSince1970
                                              filterUserIDList:@[]
                                                     onSuccess:^(NSArray<OIMGroupMemberInfo *> * _Nullable groupMembersInfo) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

    public void getGroupMemberListByJoinTime(OnBase<List<GroupMembersInfo>> callBack, String groupID, int offset, int count, long joinTimeBegin, long joinTimeEnd, List<String> excludeUserIDList)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase<List<GroupMembersInfo>>	是	回调接口
groupID	String	是	群ID
offset	int	是	开始下标
count	int	是	总数
joinTimeBegin	int	是	加入开始时间
joinTimeEnd	int	是	加入结束时间
excludeUserIDList	List<String>	否	剔除不被查询的成员 ID

返回结果

代码示例

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

            }

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

            }
        },  groupID,  offset,  count,  joinTimeBegin,  joinTimeEnd, excludeUserIDList)

uni-app

函数原型

IMSDK.getGroupMemberListByJoinTimeFilter({
    groupID: string;
    offset: number;
    count: number;
    joinTimeBegin: number;
    joinTimeEnd: number;
    filterUserIDList: string[];
}, operationID?: string): Promise<WsResponse<GroupMemberItem[]>>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数
joinTimeBegin	number	是	最早加入时间，为 0 时不限制
joinTimeEnd	number	是	最晚加入时间，为 0 时不限制
filterUserIDList	string[]	是	需要排除的群成员 userID 列表

返回结果

参数名称	参数类型	描述
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();

IMSDK.getGroupMemberListByJoinTimeFilter({
  groupID: '',
  offset: 0,
  count: 20,
  joinTimeBegin: 0,
  joinTimeEnd: 0,
  filterUserIDList: ['userID'],
})
  .then(({ data }) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron

函数原型

IMSDK.asyncApi("getGroupMemberListByJoinTimeFilter",operationID: string;
  {
    groupID: string;
    offset: number;
    count: number;
    joinTimeBegin: number;
    joinTimeEnd: number;
    filterUserIDList: string[];
  }
): Promise<GroupMemberItem[]>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群ID
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数
joinTimeBegin	number	是	最早加入时间，为 0 时不限制
joinTimeEnd	number	是	最晚加入时间，为 0 时不限制
filterUserIDList	string[]	是	需要排除的群成员 userID 列表

返回结果

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

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

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getGroupMemberListByJoinTimeFilter', IMSDK.uuid(), {
  groupID: '',
  offset: 0,
  count: 20,
  joinTimeBegin: 0,
  joinTimeEnd: 0,
  filterUserIDList: ['userID'],
})
  .then((data) => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDK.getGroupMemberListByJoinTimeFilter({
  groupID: string,
  offset: number,
  count: number,
  joinTimeBegin: number,
  joinTimeEnd: number,
  filterUserIDList: string[],
}, operationID?: string): Promise<GroupMemberItem[]>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群ID
offset	number	是	起始偏移，分页拉取使用
count	number	是	分页拉取，一页拉取的成员个数
joinTimeBegin	number	是	最早加入时间，为 0 时不限制
joinTimeEnd	number	是	最晚加入时间，为 0 时不限制
filterUserIDList	string[]	是	需要排除的群成员 userID 列表
operationID	string	否	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

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

代码示例

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

OpenIMSDK.getGroupMemberListByJoinTimeFilter({
  groupID: '',
  offset: 0,
  count: 20,
  joinTimeBegin: 0,
  joinTimeEnd: 0,
  filterUserIDList: ['userID'],
})
  .then((data) => {
    // 调用成功
  })
  .catch((error) => {
    // 调用失败
  });

Unity

函数原型

public static void GetGroupMemberListByJoinTimeFilter(OnBase<List<GroupMember>> cb, string groupId, int offset, int count, long joinTimeBegin, long joinTimeEnd, string[] filterUserIDList)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnBase<List<GroupMember>>	是	回调接口
groupId	string	是	群ID
offset	int	是	开始下标
count	int	是	总数
joinTimeBegin	long	是	加入开始时间
joinTimeEnd	long	是	加入结束时间
excludeUserIDList	string[]	否	剔除不被查询的成员 ID

返回结果

代码示例

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

},"groupId",0,0,0,0,{""});