SDKsReact Native

Remove group members

OpenIM React Native SDK guide for remove group members.

Call kickGroupMember() to remove one or more members from a group.

await OpenIMSDK.kickGroupMember({
  groupID: 'group-001',
  reason: 'No longer involved in the project',
  userIDList: ['user-002'],
});

Parameters

| Parameter | Type | Required | Description | | --- | --- | --- | | groupID | string | Yes | ID of the target group. | | reason | string | Yes | Removal reason. Pass an empty string when no reason is needed. | | userIDList | string[] | Yes | User IDs of the members to remove. |

When the call completes, the specified members are removed from the group. Removing a member triggers OnGroupMemberDeleted; see Get group members for event handling.

Was this page helpful?