Skip to main content

getGroupMemberList

Feature Introduction

Description

Retrieve member information of a specified group.

Note

(1) The caller must be a member of this group to call. (2) Since it is fetched from the APP locally, it is recommended to retrieve a maximum of 10,000 at once.

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 NameParameter TypeRequiredDescription
groupIDNSStringYesGroup ID
filterOIMGroupMemberFilterYesMember role
offsetNSIntegerYesStarting offset
countNSIntegerYesNumber of members

Return Result

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

Code Example


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

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

}];