Skip to main content

getGroupMemberListByJoinTimeFilter

Feature Introduction

Description

Fetches group member information of a specific group with the ability to filter by join time.

Note
  1. The caller must be a member of the group to invoke this.
  2. Since the data is retrieved locally from the APP, a single request should not exceed 10,000 members.

Function Prototype


- (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;

Input Parameters

Parameter NameParameter TypeRequiredDescription
groupIDNSStringYesGroup ID
offsetNSIntegerYesStarting offset for pagination
countNSIntegerYesNumber of members per page
joinTimeBeginNSIntegerYesEarliest join time (unlimited if 0)
joinTimeEndNSIntegerYesLatest join time (unlimited if 0)
filterUserIDListNSArray <NSString *>YesList of group member userIDs to exclude

Return Results

Parameter NameParameter TypeDescription
onSuccessNSArray< OIMGroupMemberInfo *>Successful return
onFailureOIMFailureCallbackFailed return

Code Example


[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) {
}];