SDKsiOS

Search group members

Search members of a specified iOS group.

Invoke searchGroupMembers:onSuccess:onFailure: to search for group members within a specified group by user ID or group nickname:

Parameters

Parameter	Type	Required	Description
`searchParam`	`OIMSearchGroupMembersParam *`	Yes	Search parameter model defining target group, keywords, match options, and pagination.

OIMSearchGroupMembersParam properties

Parameter	Type	Required	Description
`groupID`	`NSString *`	Yes	Target group ID.
`keywordList`	`NSArray<NSString > `	Yes	List of search keywords.
`isSearchUserID`	`BOOL`	No	Whether to match member user IDs.
`isSearchMemberNickname`	`BOOL`	No	Whether to match group-specific nicknames.
`offset`	`NSInteger`	Yes	Pagination offset index (starts from `0`).
`count`	`NSInteger`	Yes	Maximum number of results per page.

Code example

OIMSearchGroupMembersParam *param = [OIMSearchGroupMembersParam new];
param.groupID = @"group_1001";
param.keywordList = @[@"Alex"];
param.isSearchUserID = YES;
param.isSearchMemberNickname = YES;
param.offset = 0;
param.count = 20;

[[OIMManager manager] searchGroupMembers:param
                               onSuccess:^(NSArray<OIMGroupMemberInfo *> *members) {
                                   [self replaceSearchResults:members];
                               }
                               onFailure:^(NSInteger code, NSString *message) {
                                   NSLog(@"searchGroupMembers failed: %ld %@", (long)code, message);
                               }];

Return value

The onSuccess callback delivers an array of matched OIMGroupMemberInfo models (NSArray<OIMGroupMemberInfo *> *). If no matching members are found, it returns an empty array.

State changes after the call

Query offset reset: Reset offset to 0 whenever search terms or filter flags change.
Read-only query: Search operations query locally cached members and do not trigger delegate callbacks. For member event listeners, refer to Group member queries overview.

Was this page helpful?