Browse SDKs · iOS
Platform
SDKsiOS

Check users’ group membership

Check which users belong to a specified iOS group.

Copy

Invoke getUsersInGroup:userIDs:onSuccess:onFailure: to quickly determine which user IDs from a candidate list currently belong to a specified group:

Parameters

ParameterTypeRequiredDescription
groupIDNSString *YesTarget group ID.
userIDsNSArray<NSString *> *YesCandidate user ID list to evaluate.

Code example

[[OIMManager manager] getUsersInGroup:@"group_1001"
                              userIDs:@[@"user_001", @"user_002", @"user_003"]
                            onSuccess:^(NSArray<NSString *> *userIDs) {
                                [self replaceUsersInGroup:userIDs];
                            }
                            onFailure:^(NSInteger code, NSString *message) {
                                NSLog(@"getUsersInGroup failed: %ld %@", (long)code, message);
                            }];

Return value

The onSuccess callback delivers an array of user ID strings (NSArray<NSString *> *) identifying only the candidates who are confirmed members of the group.

State changes after the call

  1. Lightweight membership filtering: This method verifies membership directly without retrieving or deserializing heavyweight member profile models.
  2. Read-only query: Checking membership does not trigger delegate events. For complete member profiles and event handling, refer to Group member queries overview.