SDKsiOS

Remove group members

Remove members from an iOS group.

Invoke kickGroupMember:reason:usersID:onSuccess:onFailure: to remove one or more specified members from a group (administrators cannot remove the owner or fellow administrators):

Parameters

Parameter	Type	Required	Description
`groupID`	`NSString *`	Yes	Target group ID.
`reason`	`NSString *`	No	Removal explanation or reason.
`usersID`	`NSArray<NSString > `	Yes	List of member user IDs to remove.

Code example

[[OIMManager manager] kickGroupMember:@"group_1001"
                               reason:@"Violation of group guidelines"
                              usersID:@[@"user_003"]
                            onSuccess:^(NSArray<OIMGroupInviteResult *> *results) {
                                for (OIMGroupInviteResult *item in results) {
                                    NSLog(@"kicked user: %@, result: %ld", item.userID, (long)item.result);
                                }
                            }
                            onFailure:^(NSInteger code, NSString *message) {
                                NSLog(@"kickGroupMember failed: %ld %@", (long)code, message);
                            }];

Return value

The onSuccess callback delivers an array of member removal outcomes (NSArray<OIMGroupInviteResult *> *).

State changes after the call

Local state removal: The client removes member records corresponding to groupID:userID from local storage and displays.
Event notification: Connected group members receive the onGroupMemberDeleted: listener callback.
Re-query calibration: For member queries and listener integration, refer to Group member queries overview.

Was this page helpful?